Skip to main content
GET
/
suppressions
List suppressed addresses
curl --request GET \
  --url https://api.arkhq.io/v1/suppressions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "789",
      "address": "[email protected]",
      "createdAt": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  ],
  "page": 1,
  "perPage": 30,
  "total": 150,
  "totalPages": 5,
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}

Authorizations

​
Authorization
string
header
required

Use your API key from arkhq.io/org/credentials

Authorization: Bearer YOUR_API_KEY

Query Parameters

​
page
integer
default:1
​
perPage
integer
default:30
Required range: x <= 100

Response

List of suppressions

​
data
object[]
required

List of suppressed addresses

​
page
integer
required

Current page number (1-indexed)

Example:

1

​
perPage
integer
required

Items per page

Example:

30

​
total
integer
required

Total number of items

Example:

150

​
totalPages
integer
required

Total number of pages

Example:

5

​
meta
object
required