Domains /
List domains
Required permission
Account > Domains > General > Read
Query parameters
per_page
integerThe number of results to display per request. Maximum of 100 results per page.
page
integerThe page number to access.
cursor
stringThe cursor returned from the previous page of results, used to request the next page.
Response body
- {object}
Response object.
data
{object} requiredResult data.
domains
[array] requiredA list of domains registered to this account.
- {object}
Details about a domain.
name
string requiredThe domain name.
status
string requiredThe status of the domain verification.
one ofpending, verifiedhostname
string requiredThe hostname to add to your domain's DNS records as a TXT record to verify the domain.
token
string requiredThe token to add as the content of the TXT record to verify the domain.
pagination
{object} requiredData about the endpoint pagination.
hasNextPage
boolean requiredIs there another page of results available?
cursor
stringThe cursor to access the next page of results.
count
number requiredThe number of results returned by this request.
GET /v1/domains
Example response
200 OK
JSON
{
"data": {
"domains": [
{
"name": "example.com",
"status": "verified",
"hostname": "nfverify1608026055",
"token": "e596987b52855a4a773ef580ce2985d7746b37ce8b2a443d20fa27b913d8f57"
}
]
},
"pagination": {
"hasNextPage": false,
"count": 1
}
}