Peeker Partner API

GET

/

domains

List domains

curl --request GET \
  --url https://api.peeker.ai/partner/v1/domains \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "domain": "acme-mail.com",
      "category": "connected",
      "status": "active",
      "provider": "google",
      "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "order_id": "ord_01HZX0OR1A2B3C4D5E6F7G8H",
      "usable_for": [
        "google",
        "microsoft"
      ],
      "forwarding_url": "https://acme.com",
      "smartlead_client_id": "301",
      "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/partner/v1/domains?per_page=25",
    "next": "https://api.peeker.ai/partner/v1/domains?per_page=25&page_token=eyJjdXJzb3IiOiJ4eXoifQ"
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains",
    "per_page": 25,
    "returned": 2
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

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"

smartlead_client_id

string

Match the Smartlead client ID returned on domain records in your account. Combines with other filters. Unknown IDs return no matches. Follow pagination links even when a page is empty. Omit this parameter to include all clients.

Minimum string length: 1

Example:

"301"

available_to_order

boolean

default:false

When true, return only owned inventory currently eligible for a new inbox order. Previously ordered domains must have fully cancelled inboxes, an unexpired paid registration, and no conflicting order claims. Combines with customer_id or smartlead_client_id and other filters. Omitted or false leaves results unchanged. Follow pagination links even when a page is empty. This is not a reservation; ordering rechecks eligibility. Existing status values are unchanged.

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 signed token from the page_token query parameter of links.next. Prefer requesting the complete links.next URL directly; it is a URL, not a token. GET /orders also accepts that complete next-page URL as this parameter's value. When passing a token or URL in this parameter, keep the same list filters. Stop when links.next is null; do not send the strings "null" or "undefined".

Response

A page of domains.

data

object[]

required

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Last modified on October 5, 2026

List domains

curl --request GET \
  --url https://api.peeker.ai/partner/v1/domains \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "domain": "acme-mail.com",
      "category": "connected",
      "status": "active",
      "provider": "google",
      "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "order_id": "ord_01HZX0OR1A2B3C4D5E6F7G8H",
      "usable_for": [
        "google",
        "microsoft"
      ],
      "forwarding_url": "https://acme.com",
      "smartlead_client_id": "301",
      "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/partner/v1/domains?per_page=25",
    "next": "https://api.peeker.ai/partner/v1/domains?per_page=25&page_token=eyJjdXJzb3IiOiJ4eXoifQ"
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains",
    "per_page": 25,
    "returned": 2
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}

{
  "error": {
    "code": "emailbison_super_admin_key",
    "message": "Use an EmailBison workspace/user API key; super-admin keys are not accepted.",
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "field": "credentials.api_key",
    "details": {}
  }
}