Skip to main content
GET
/
v1
/
team
/
domains
Get domains
curl --request GET \
  --url https://api.oneofnone.io/v1/team/domains \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "fqdn": "<string>",
    "apex_domain": "<string>",
    "type": "SHORT_URL",
    "status": "PENDING",
    "is_enabled": true,
    "is_primary": true,
    "assigned_app": "SHORT_URL",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
x-api-key
string
header
required

The API key required for accessing protected routes. It should be included in the request headers as x-api-key.

Response

Successfully retrieved domains.

​
id
string<uuid>

Unique identifier for the domain.

​
fqdn
string

Fully qualified domain name.

​
apex_domain
string

The apex (root) domain.

​
type
enum<string>

The purpose this domain is configured for.

Available options:
SHORT_URL,
LANDING_PAGE,
MAIL_SENDER,
UNASSIGNED
​
status
enum<string>

Current verification status of the domain.

Available options:
PENDING,
VERIFYING,
VERIFIED,
FAILED,
DELETED,
BLOCKED
​
is_enabled
boolean

Whether the domain is currently active.

​
is_primary
boolean

Whether this is the primary domain for its type.

​
assigned_app
enum<string>

Which application this domain is assigned to.

Available options:
SHORT_URL,
LANDING_PAGE,
MAIL_SENDER,
UNASSIGNED
​
created_at
string<date-time>

When the domain was created.

​
updated_at
string<date-time>

When the domain was last updated.