Domains

List the organization's domains.

Required OAuth scope: domains:read

get/v2/domains/

Request

Query parameters

filter[access]'PUBLIC' | 'PRIVATE' | 'PRIVATE_CODE' nullable

Return only domains with this access mode: PUBLIC, PRIVATE, or PRIVATE_CODE.

filter[name]string nullable

Exact hostname match. Returns the single domain with that name, if any.

includestring nullable

Comma-separated related resources to include. Supported: theme.

page[size]integer

Maximum number of records to return.

page[cursor]string nullable

Opaque cursor from the previous page's links.next.

Response

OK

metaobject nullable

Pagination metadata, e.g. {"page_size": 25}.

includedobject[] nullable

Related resources requested via ?include=. Absent when no include was requested.

Changes

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added to the response property anyOf list for the response status

    • info

      removed subschema #1 from the response property anyOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status