Skip to main content
GET
/
allowlists
List Allowlist Items
curl --request GET \
  --url https://api.loopreturns.com/api/v1/allowlists \
  --header 'X-Authorization: <api-key>'
{
  "data": [
    {
      "id": 123,
      "type": "order",
      "value": "<string>",
      "secondary_value": "<string>"
    }
  ],
  "links": [
    {
      "url": "<string>",
      "label": "<string>",
      "active": true
    }
  ],
  "next_page_url": "<string>",
  "current_page": 123,
  "from": "<string>",
  "first_page_url": "<string>",
  "last_page": "<string>",
  "last_page_url": "<string>",
  "path": "<string>",
  "per_page": 123,
  "prev_page_url": "<string>",
  "to": 123,
  "total": 123
}

Authorizations

X-Authorization
string
header
required

Response

Success

data
object[]

The data for each entry in the allowlist.

An array of links to each page.

next_page_url
string | null

The link to the next page of paginated results.

current_page
integer

The identifier associated with the current page.

from
string | null

The number of the first allowlist entry on the page.

first_page_url
string | null

The link to the first page of paginated results.

last_page
string | null

The identifier associated with the last page.

last_page_url
string | null

The link to the last page of paginated results.

path
string | null

The endpoint's path.

per_page
integer

The number of allowlist entries per page.

prev_page_url
string | null

The link to the previous page of paginated results.

to
integer | null

The number of the last allowlist entry on the page.

total
integer

The total number of allowlist entries returned.