Skip to main content
GET
List

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0
parentId
string

Restrict to the children of one domain. Pass an empty string to return only top-level domains. Omit to return every domain at any level.

Pattern: ^$|^(domain-)?[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
includeDeleted
boolean

Include soft-deleted domains.

excludeDefinition
boolean

Omit the membership definition from each domain.

Response

200 - application/json

Success

domains
Domain · object[]

The matching domains.

pageInfo
PageInfo · object

Pagination cursor for the next page.