Skip to main content
GET
List consents

Authorizations

Authorization
string
header
required

An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.

Query Parameters

value
string

Exact email address or E.164 number (URL-encode the plus sign as %2B).

Maximum string length: 254
contactId
string
channel
enum<string>
Available options:
email,
sms
active
boolean

true returns unrevoked rows only.

limit
integer
default:50
Required range: 1 <= x <= 500
cursor
string

The nextCursor of the previous page.

Response

200 - application/json

A page of consents

data
object[]
required
nextCursor
string | null
required