List domains

List the organization's domains.

Required OAuth scope: domains:read

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}.

linksobject nullable

Pagination links, e.g. {"self": "...", "next": "...", "prev": null}.

has_moreboolean required

Whether additional pages exist after this one.

next_cursorstring nullable

Opaque cursor to pass as page[cursor] for the next page; null on the last page.

includedobject[] nullable

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