Skip to content
Artbucket

The organization's domains

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

Its app’s and its portals’. Organization admin.

Scope: admin.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Domains

Media typeapplication/json
object
data
required
Array<object>
object
host
required
string
verified
required
boolean
record
required

What proves it: add this record at your DNS host

object
type
required
string
Allowed value: TXT
name
required
string
value
required
string
cname
required
Any of:
object
type
required
string
Allowed value: CNAME
name
required
string
value
required
string
app
required

Used for the app: the whole app answers here

boolean
primary
required

The default of those used for the app: links in email point here

boolean
portal
required

The portal it serves, by slug; null for the whole app

string | null
url
required
string format: uri
Example
{
  "data": [
    {
      "record": {
        "type": "TXT"
      },
      "cname": {
        "type": "CNAME"
      }
    }
  ]
}

default

Section titled “default”

An error

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