Get a suppression list

GET

/v1/suppression-lists/{suppressionListId}

const url = 'https://api.postlever.com/v1/suppression-lists/497f6eca-6276-4993-bfeb-53cbbbba6f08';
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/497f6eca-6276-4993-bfeb-53cbbbba6f08 \
  --header 'Authorization: <Authorization>'

Fetches one of your suppression lists.

format states what the list stores, and therefore what the add-records endpoint accepts for it: plain text takes email addresses, md5 and sha512 take hex digests.

A suppression list attached to an offer is not addressable here and returns 404 not_found_error.

Authorizations

postlever_api_key

Parameters

Path Parameters

suppressionListId

required

string format: uuid

The id of the suppression list.

Responses

200

The suppression list.

application/json

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

Example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "Affiliate opt-outs",
  "format": "plain text",
  "isGlobal": false,
  "recordCount": 1024
}

400

A path parameter is not a valid UUID.

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": "suppressionListId must be a UUID",
  "code": "invalid_request_error",
  "instance": "/v1/suppression-lists/not-a-uuid",
  "errors": [
    {
      "detail": "suppressionListId must be a UUID"
    }
  ]
}

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"
}

404

No suppression list with this id exists in your account.

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#not_found_error",
  "status": 404,
  "title": "Not found",
  "detail": "Suppression list not found",
  "code": "not_found_error",
  "instance": "/v1/suppression-lists/497f6eca-6276-4993-bfeb-53cbbbba6f08/records"
}