Skip to main content
GET
List domains

Authorizations

Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Partner API key (pk_live_… or pk_test_…).

Query Parameters

category
enum<string>

inventory = not on an order yet. connected = already on an order.

Available options:
inventory,
connected
customer_id
string

Show only domains owned by one customer.

Pattern: ^cus_
Example:

"cus_01HZX0C6Z3K4M5N6P7Q8R9S0"

usable_for
enum<string>

Filter by which mail provider the domain can serve.

Available options:
google,
microsoft
status
enum<string>

Filter by status.

Available options:
available,
in_progress,
active,
failed,
action_required
per_page
integer
default:25

How many rows per page (default 25, max 100).

Required range: 1 <= x <= 100
page_token
string

Opaque cursor from links.next. Pass it through as-is.

Response

A page of domains.

data
object[]
required
meta
object
Last modified on August 25, 2026