Skip to main content
GET
List email opt-ins

Authorizations

Authorization
string
header
required

API key authentication via Bearer token

Query Parameters

limit
number
default:10

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100
Example:

10

offset
number | null
default:0

Number of items to skip

Required range: x >= 0
Example:

0

email
string<email>

Only records for this address (case-insensitive)

includeWithdrawn
boolean
default:false

Include withdrawn records as well as live ones

Example:

true

Response

List of email opt-ins with pagination metadata

data
object[]
required
meta
object
Last modified on October 6, 2026