Skip to main content
GET
List domains
List domains attached to the workspace. Requires Custom domains: Read (custom_domains.view). Every item is the complete safe resource described in Retrieve a domain.

Filters

Filters combine with AND. Unknown parameters, custom sorting, numeric IDs, and simultaneous starting_after and ending_before are rejected.

Response and pagination

Results are newest first. Pass next_cursor as starting_after with the same filters to get the next page. Pass previous_cursor as ending_before to move back. Never construct cursors yourself. An unavailable cursor returns 404 resource_not_found; no matches returns an empty domains array. links_count is isolated to this workspace. No numeric or operational IDs are returned.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits. This endpoint uses cursor pagination; see Pagination.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Query Parameters

Required string length: 1 - 255
dns_status
enum<string>
Available options:
pending,
verifying,
verified,
failed
ssl_status
enum<string>
Available options:
pending,
processing,
active,
failed
starting_after
string

Return the next, older page. Mutually exclusive with ending_before.

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
ending_before
string

Return the previous, newer page. Mutually exclusive with starting_after.

Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
page_size
integer
default:50
Required range: 1 <= x <= 100

Response

Domains returned successfully.

domains
object[]
required
pagination
object
required
status
string
required
Allowed value: "success"