GET
/
blocklists
curl --request GET \
  --url https://api.loopreturns.com/api/v1/blocklists \
  --header 'X-Authorization: <api-key>'
{
  "data": [
    {
      "id": 1,
      "type": "order",
      "value": "example@example.com",
      "secondary_value": "example.2@example.com"
    }
  ],
  "links": [
    {
      "url": "https://api.loopreturns.com/api/v1/blocklists?page=1",
      "label": 1,
      "active": true
    }
  ],
  "next_page_url": "https://api.loopreturns.com/api/v1/blocklists?page=2",
  "current_page": 1,
  "from": 1,
  "first_page_url": "https://api.loopreturns.com/api/v1/blocklists?page=1",
  "last_page": 2,
  "last_page_url": "https://api.loopreturns.com/api/v1/blocklists?page=2",
  "path": "https://api.loopreturns.com/api/v1/blocklists",
  "per_page": 15,
  "prev_page_url": "<string>",
  "to": 15,
  "total": 20
}

Authorizations

​
X-Authorization
string
header
required

Response

200
application/json
Success
​
data
object[]

The data for each entry in the blocklist.

​
links
object[]
​
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 blocklist 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 blocklist 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 blocklist entry on the page.

​
total
integer

The total number of blocklist entries returned.

Delete DestinationCreate Blocklist Item