Sign in

v1

latestOpenAPI 3.1.02026-07-2689175245.8 KB
Blocklist

List Blocklist Items

Retrieve a list of paginated blocklist entries.

Required API key scope

  • Orders
get/blocklists

Response

Success

next_page_urlstring nullable

The link to the next page of paginated results.

current_pageinteger

The identifier associated with the current page.

fromstring nullable

The number of the first blocklist entry on the page.

first_page_urlstring nullable

The link to the first page of paginated results.

last_pagestring nullable

The identifier associated with the last page.

last_page_urlstring nullable

The link to the last page of paginated results.

pathstring nullable

The endpoint's path.

per_pageinteger

The number of blocklist entries per page.

prev_page_urlstring nullable

The link to the previous page of paginated results.

tointeger nullable

The number of the last blocklist entry on the page.

totalinteger

The total number of blocklist entries returned.

Example response

{
  "data": [
    {
      "id": 1,
      "value": "example@example.com",
      "secondary_value": "example.2@example.com",
      "created_at": "2023-06-09 00:00:00"
    }
  ],
  "links": [
    {
      "url": "https://api.loopreturns.com/api/v1/blocklists?page=1",
      "active": true
    }
  ],
  "next_page_url": "https://api.loopreturns.com/api/v1/blocklists?page=2",
  "current_page": 1,
  "first_page_url": "https://api.loopreturns.com/api/v1/blocklists?page=1",
  "last_page_url": "https://api.loopreturns.com/api/v1/blocklists?page=2",
  "path": "https://api.loopreturns.com/api/v1/blocklists",
  "per_page": 15,
  "to": 15,
  "total": 20
}