Skip to main content
GET
Node.js

Headers

X-Api-Key
string
required

Query Parameters

name
string

Filter by custom tracking domain label

status
enum<string>

Filter by status

Available options:
active,
disabled
scope
enum<string>

Filter by scope

Available options:
click,
open,
unsubscribe
limit
integer
default:100

The maximum number of domains to return. The default is 100.

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

The number of domains to skip before returning results. The default is 0.

Required range: x >= 0

Response

Response with the list of custom tracking domains

custom_tracking_domains
object[]
required

List of custom tracking domains matching the filter criteria

total
integer
required

Total number of custom tracking domains