List suppression lists

GET

/v1/suppression-lists

const url = 'https://api.postlever.com/v1/suppression-lists?page=1&pageSize=200&sort=name';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.postlever.com/v1/suppression-lists?page=1&pageSize=200&sort=name' \
  --header 'Authorization: <Authorization>'

Lists the suppression lists in your account, one page at a time, sorted by name.

Suppression lists attached to an offer are not included. Those are managed through the offer they belong to.

Authorizations

postlever_api_key

Parameters

Query Parameters

page

integer

default: 1 >= 1

1-based page number.

pageSize

integer

default: 200 >= 10 <= 200

Number of suppression lists per page.

sort

string

default: name

Allowed values: name -name createdAt -createdAt updatedAt -updatedAt

Sort field, prefixed with - for descending.

Responses

200

One page of your suppression lists.

application/json

object

data

required

Array<object>

object

required

string format: uuid

name

required

string

format

required

What the list stores, and therefore what the add-records endpoint accepts for it.

string

Allowed values: plain text md5 sha512

isGlobal

required

Whether the list applies to every brand in your account.

boolean

recordCount

required

How many records the list holds.

integer

createdAt

required

string format: date-time

updatedAt

required

When the list was last changed, including by records being added.

string format: date-time

pagination

required

totalCount is the number of items matching the request across all pages; totalPages is that count divided by pageSize, rounded up, and is 0 when nothing matches.

object

page

required

integer

pageSize

required

integer

totalCount

required

integer

totalPages

required

integer

Example

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "Affiliate opt-outs",
      "format": "plain text",
      "isGlobal": false,
      "recordCount": 1024
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 200,
    "totalCount": 3,
    "totalPages": 1
  }
}

400

Invalid request payload. Details are provided in the error response.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.postlever.com/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "\"nickname\" is not an attribute in the contact schema",
  "code": "invalid_request_error",
  "instance": "/v1/contacts",
  "errors": [
    {
      "detail": "\"nickname\" is not an attribute in the contact schema",
      "pointer": "/attributes/nickname"
    }
  ]
}

401

Missing or invalid API key.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.postlever.com/error-codes#authentication_error",
  "status": 401,
  "title": "Authentication failed",
  "detail": "Missing or invalid API key",
  "code": "authentication_error",
  "instance": "/v1/contacts"
}

403

Permission denied.

application/json

Error envelope returned by every v1 endpoint for failures, following RFC 9457 Problem Details with code and errors extensions.

object

type

required

URI identifying the problem type; dereferences to its documentation.

string format: uri

status

required

HTTP status code applicable to this problem.

integer

title

required

Short, human-readable summary of the problem type.

string

detail

required

Detailed explanation specific to this occurrence.

string

code

required

Error code identifying the specific error condition.

string

Allowed values: invalid_request_error authentication_error permission_error not_found_error conflict_error api_error contact_exists operation_in_progress

instance

URI reference identifying this specific occurrence (the request URI).

string format: uri-reference

errors

Provides additional information when the error relates to specific request fields.

Array<object>

object

detail

required

Detailed explanation for this specific field error.

string

pointer

JSON Pointer (RFC 6901) to the request body value that caused the error (e.g. /email, /attributes/firstName).

string

parameter

The URI query parameter that caused the error (e.g. pageSize, name[invalid]).

string

Example

{
  "type": "https://docs.postlever.com/error-codes#permission_error",
  "status": 403,
  "title": "Permission denied",
  "detail": "api key required",
  "code": "permission_error",
  "instance": "/v1/contacts"
}