Retrieve a list of blocklists

Retrieve a list of blocklists.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

Responses
200

A list of Blocklists was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
type
required
string

The blocklist type.

Enum: "payment-card" "bank-account" "customer-id" "email" "email-domain" "ip-address" "country" "fingerprint" "bin" "address"
value
required
string

The blocklist value.

id
string <= 50 characters

The blocklist identifier string.

expirationTime
string <date-time>

The blocklist expiration time.

createdTime
string <date-time>

The blocklist created time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/blocklists
Request samples
$blocklists = $client->blocklists()->search([
    'filter' => 'value:testValue',
]);
Response samples
application/json
[
  • {
    }
]