Skip to main content
GET
curl

Authorizations

X-Api-Key
string
header
required

Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Query Parameters

limit
integer
default:20

Maximum number of records to return. Must be between 1 and 100. Defaults to 20.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip before returning results. For example, an offset of 0 starts at the most recent record, while an offset of 50 starts at the 51st. Defaults to 0.

Required range: x >= 0
type
enum<string> | null

Only return bounces or unsubscribes. Returns both when not set.

Available options:
bounces,
unsubscribes
workspace_id
integer | null

Only return entries from this workspace. Returns entries from all your workspaces when not set.

Response

Success

A page of suppression list entries.

data
object[]
required

Suppression list entries, newest first.

total
integer
required

Total number of entries matching the filter.

Required range: x >= 0