organizationDomains

Requires at least one of the permissions settings:organization:read or settings:tenant:read.

Lists the hostnames that reach your organization's portal and their setup status. The platform hostname is always listed; it cannot be removed or made primary. Needs settings:organization:read, or settings:tenant:read.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query OrganizationDomains {
  organizationDomains {
    id
    status
    createdAt
    hostname
    isPrimary
    kind
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query OrganizationDomains {\n  organizationDomains {\n    id\n    status\n    createdAt\n    hostname\n    isPrimary\n    kind\n  }\n}"
}
EOF

Response:

{
  "data": {
    "organizationDomains": [
      {
        "id": "id",
        "status": "ACTIVE",
        "createdAt": "2025-01-15T00:00:00Z",
        "hostname": "string",
        "isPrimary": true,
        "kind": "CUSTOM"
      }
    ]
  }
}

organizationDomains: [OrganizationDomain!]!

Type

OrganizationDomain object

A host name the organization's portal answers on.