Skip to content

Domains a portal can be served at

GET
/api/v1/sites/domains
curl --request GET \
--url http://localhost:3000/api/v1/sites/domains \
--header 'Authorization: Bearer <token>'

The organization’s verified domains, and the portal each serves. They are added and verified in Settings, Domains (/api/v1/domains).

Scope: write.

Domains

Media typeapplication/json
object
data
required
Array<object>
object
host
required
string
portal
required

The portal it serves, by slug; null: free to pick

string | null
Examplegenerated
{
"data": [
{
"host": "example",
"portal": "example"
}
]
}

An error

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
detail
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"detail": "example"
}
}