Skip to content

Your custom tracking domains, and your default subdomain

GET
/v1/buyer/domains
curl --request GET \
--url 'https://example.com/v1/buyer/domains?sort=host' \
--header 'Authorization: Bearer <token>'

Who: a workspace’s member, staff under its support access, or its key. Not for API keys.

page_size
integer
>= 1

Rows a page, up to the list’s maximum; the service’s default when left out

page_token
string

The previous page’s meta.next_page_token

sort
string

Comma-separated fields, each with - for descending

status
string

OK

Media typeapplication/json
object
data
required
Array<object>
object
certificate
required
Any of:
object
issuer
required
string
not_after
required
string format: date-time
not_before
required
string format: date-time
renew_at
required
string format: date-time
serial_number
required
string
certificate_error
required
string
check_error
required
string
cname_target
required
string
created_at
required
string format: date-time
host
required
string
id
required
integer format: int64
last_checked_at
required
string | null format: date-time
next_check_at
required
string | null format: date-time
root_redirect_url
required
string
sequence
required
integer format: int64
status
required
string | null
Allowed values: pending verified active failed
txt_name
required
string
txt_value
required
string
updated_at
required
string format: date-time
verified_at
required
string | null format: date-time
workspace_id
required
integer format: int64
default_host
required
string
meta
required
object
next_page_token
required
string | null
total
required
integer | null format: int64
total_approximate
required
boolean

Example

{
"data": [
{
"status": "pending"
}
]
}

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
"error": {
"code": "example",
"fields": {
"additionalProperty": "example"
},
"message": "example"
}
}