Peeker Partner API

GET

pool

List pool domains

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

{
  "data": [
    {
      "domain": "acme-mail.com",
      "provider": "google",
      "inbox_count": 2,
      "assignable_inbox_count": 1,
      "assigned_inbox_count": 1,
      "held_inbox_count": 1,
      "availability": "available",
      "status": "warming",
      "health": {
        "verdict": "healthy",
        "reasons": [
          "<string>"
        ],
        "checked_at": "2023-11-07T05:31:56Z"
      },
      "available_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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=eyJ..."
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains",
    "per_page": 25,
    "returned": 25
  }
}

{
  "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": {}
  }
}

{
  "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

availability

enum<string>

default:all

Available options:

all,

available,

claimed

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

One page of pool domains.

data

object[]

required

Show child attributes

links

object

required

Show child attributes

meta

object

required

Show child attributes

Last modified on October 5, 2026

List pool domains

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

{
  "data": [
    {
      "domain": "acme-mail.com",
      "provider": "google",
      "inbox_count": 2,
      "assignable_inbox_count": 1,
      "assigned_inbox_count": 1,
      "held_inbox_count": 1,
      "availability": "available",
      "status": "warming",
      "health": {
        "verdict": "healthy",
        "reasons": [
          "<string>"
        ],
        "checked_at": "2023-11-07T05:31:56Z"
      },
      "available_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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=eyJ..."
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains",
    "per_page": 25,
    "returned": 25
  }
}

{
  "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": {}
  }
}

{
  "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": {}
  }
}

Account

Provider workspaces

Bundles

Domains

Domain pool

Orders

Domain swaps

List pool domains

Authorizations

Query Parameters

Response