Skip to main content
GET
List Domains

Autorisationer

Authorization
string
header
påkrævet

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

domain:read

Overskrifter

Api-Version-Date
string

Pins the request to a dated API version.

Eksempel:

"2026-11-17"

Forespørgselsparametre

account_id
string

Only domains belonging to this account, prefixed biz_.

app_id
string

Only domains whose website serves this app, prefixed app_.

status
enum<string>

Only domains with this status: the most pressing state of their capabilities, or idle when they want nothing.

Tilgængelige muligheder:
idle,
pending,
ready,
action_required,
releasing
order
enum<string>
standard:unique_visitors_last_7_days

Field to sort by. Domains with the same value keep their creation order in the same direction.

Tilgængelige muligheder:
unique_visitors_last_7_days,
created_at,
updated_at,
domain
direction
enum<string>

Sort direction.

Tilgængelige muligheder:
asc,
desc
first
integer
standard:20

Number of results to return from the start of the range.

Nødvendigt interval: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Nødvendigt interval: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

A name or domain to find domains to buy, such as example or example.com; a subdomain or URL searches its registrable domain. Returns domains with availability instead of your domains, without other filters or pagination.

tlds
string[]

With search, check only these extensions, such as com or co.uk, returned in this order. Repeat for several, up to 100.

domain
string

Only your domain with this hostname, such as example.com.

verification
enum<string>

Only domains with verification in this state, such as ready, or any for every domain that has verification.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
registration
enum<string>

Only domains with registration in this state, such as ready, or any for every domain that has registration.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
platform
enum<string>

Only domains with platform in this state, such as ready, or any for every domain that has platform.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
subdomain
enum<string>

Only domains with subdomain in this state, such as ready, or any for every domain that has subdomain.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
website
enum<string>

Only domains with website in this state, such as ready, or any for every domain that has website.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
apple_pay
enum<string>

Only domains with apple_pay in this state, such as ready, or any for every domain that has apple_pay.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
pixel
enum<string>

Only domains with pixel in this state, such as ready, or any for every domain that has pixel.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
email
enum<string>

Only domains with email in this state, such as ready, or any for every domain that has email.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any
transfer
enum<string>

Only domains with transfer in this state, such as ready, or any for every domain that has transfer.

Tilgængelige muligheder:
pending,
ready,
action_required,
releasing,
any

Svar

Domain list

data
object[]
påkrævet
page_info
object
påkrævet