Get domain suppressions

GET

/api/domains/{domain}/suppressions

const url = 'https://smtp-app.kirim.email/api/domains/example.com/suppressions?type=unsubscribe&page=1&per_page=10';
const options = {method: 'GET', headers: {Authorization: 'Basic <credentials>'}};

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://smtp-app.kirim.email/api/domains/example.com/suppressions?type=unsubscribe&page=1&per_page=10' \
  --header 'Authorization: Basic <credentials>'

Retrieve a paginated list of suppressions for a domain

Authorizations

basicAuth

Parameters

Path Parameters

domain

required

string

Example

example.com

Domain name that must be owned by the authenticated user. The domain must be verified and properly configured for email sending.

Query Parameters

type

string

default: unsubscribe

Allowed values: unsubscribe bounce whitelist

Suppression type

search

string

Search suppressions by recipient

page

integer

default: 1 >= 1

Page number

per_page

integer

default: 10 >= 10 <= 100

Number of items per page

Responses

200

Success

application/json

object

success

boolean

data

Array<object>

Suppression entry

object

integer

type

string

Allowed values: unsubscribe bounce whitelist

recipient_type

string

Allowed values: email domain

recipient

string

tags

string

nullable

description

string

nullable

source

string

nullable

created_at

integer

pagination

object

filters

object

Example

{
  "success": true,
  "data": [
    {
      "id": 1,
      "type": "unsubscribe",
      "recipient_type": "email",
      "recipient": "[email protected]",
      "tags": "marketing",
      "description": "Opted out from newsletter",
      "source": "api",
      "created_at": 1711234567
    }
  ]
}

401

Unauthorized - Invalid or missing authentication credentials

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Unauthorized"
}

404

Not Found - Domain not found

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Domain not found"
}

429

Too Many Requests - Rate limit exceeded. Retry after the specified time.

application/json

object

success

boolean

message

string

Example

{
  "success": false,
  "message": "Too many attempts. Please try again later."
}

Headers

Retry-After

integer

Seconds until rate limit resets

X-RateLimit-Limit

integer

Maximum requests per minute

X-RateLimit-Remaining

integer

Remaining requests in current window