Skip to main content
GET
/
domains
Listing domains
curl --request GET \
  --url https://api.peeker.ai/api/partner/v1/domains \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "domain": "acme-mail.com",
      "category": "connected",
      "status": "active",
      "provider": "google",
      "user_id": "usr_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "order_id": "ord_01HZX0OR1A2B3C4D5E6F7G8H",
      "usable_for": [
        "google",
        "microsoft"
      ],
      "forwarding_url": "https://acme.com",
      "created_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "dom_01HZX0D03A2B3C4D5E6F7G8H",
      "domain": "spare-acme.com",
      "category": "inventory",
      "status": "available",
      "usable_for": [
        "google",
        "microsoft"
      ],
      "created_at": "2026-04-30T10:00:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/api/partner/v1/domains?per_page=25",
    "next": "https://api.peeker.ai/api/partner/v1/domains?per_page=25&page_token=eyJjdXJzb3IiOiJ4eXoifQ"
  },
  "meta": {
    "path": "https://api.peeker.ai/api/partner/v1/domains",
    "per_page": 25,
    "returned": 2
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.peeker.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

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

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Query Parameters

​
category
enum<string>

inventory = ready but not on an order. connected = on an order.

Available options:
inventory,
connected
​
user_id
string

Show only domains owned by one customer.

​
user_email
string

Show only domains owned by one customer, identified by email.

​
usable_for
enum<string>

Filter by which mail provider the domain can serve.

Available options:
google,
microsoft
​
status
enum<string>

Filter to one domain status.

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

Page size; default 25, max 100.

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

Opaque token returned in links.next. Do not parse or build by hand.

Response

200 - application/json

A page of domains.

​
data
object[]
required
​
links
object
​
meta
object
Last modified on May 14, 2026