---
title: "List Allowlist Items"
method: GET
path: "/allowlists"
tags: ["Allowlist"]
---

# List Allowlist Items

`GET /allowlists`

Retrieve a list of paginated allowlist entries.

### Required API key scope
- Orders

## Response `200`

Success

- PaginatedAllowlistResponse
  - `data` AllowlistEntryWithCreatedAtResponse[] — The data for each entry in the allowlist.
    - `id` integer — The unique identifier associated with the allowlist entry.
    - `type` 'order' | 'email' — The type of value allowed by this allowlist entry. `order` is the order number of the allowed order and `email` is the customer's email address.
    - `value` string — The allowed value. Returns made using this value will override any other return ineligibility.
    - `created_at` string, nullable — The date and time at which the entry was created.
  - `links` PaginatedAllowlistLink[] — An array of links to each page.
    - `url` string — The link to a page.
    - `label` string — The page's label, used to store either page numbers or previous/next page data.
    - `active` boolean — Whether the page is active.
  - `next_page_url` string, nullable — The link to the next page of paginated results.
  - `current_page` integer — The identifier associated with the current page.
  - `from` string, nullable — The number of the first allowlist entry on the page.
  - `first_page_url` string, nullable — The link to the first page of paginated results.
  - `last_page` string, nullable — The identifier associated with the last page.
  - `last_page_url` string, nullable — The link to the last page of paginated results.
  - `path` string, nullable — The endpoint's path.
  - `per_page` integer — The number of allowlist entries per page.
  - `prev_page_url` string, nullable — The link to the previous page of paginated results.
  - `to` integer, nullable — The number of the last allowlist entry on the page.
  - `total` integer — The total number of allowlist entries returned.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.dev/loopreturns/apis/listings-api.md) · [All operations](https://skmtc.dev/loopreturns/apis/listings-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/loopreturns/listings-api/revisions/750e6012dbb8/schema)