List custom domains

Returns all custom domains configured for the workspace.

GET /api/v2/domains

List custom domains

cURL

curl --request GET \
  --url https://api.heymilo.ai/api/v2/domains \
  --header 'X-API-KEY: <api-key>'

200

{
  "data": [
    {
      "id": "<string>",
      "domain": "<string>",
      "cname_target": "<string>",
      "status": "<string>",
      "active": true,
      "created_at": 123,
      "updated_at": 123,
      "object": "domain"
    }
  ],
  "pagination": {
    "has_more": true,
    "total_count": 123,
    "url": "<string>"
  }
}

Authorizations

X-API-KEY · string · header · required

API key for authentication. Pass your key in the X-API-KEY header.

Headers

X-API-KEY · string | null

Authorization · string | null

X-Workspace-Id · string | null

Query Parameters

limit · integer · default: 20

Required range: 1 <= x <= 100

starting_after · string | null

Response

200

application/json

Successful Response

data · CustomDomainResponse · object[] · required

Show child attributes

pagination · PaginationMeta · object · required

Show child attributes