Peeker Partner API

GET

/

domains

/

burned

List burned domains

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

{
  "data": [
    {
      "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "domain": "acme-mail.com",
      "provider": "microsoft",
      "managed": true,
      "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "updated_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
      "domain": "imported-acme.com",
      "provider": "google",
      "managed": false,
      "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "updated_at": "2026-05-07T09:30:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/domains/burned?filter=all&per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains/burned",
    "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

filter

enum<string>

default:all

all = every burned domain. managed = on an active Peeker subscription (usually what replace-all uses).

Available options:

all,

managed

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 burned domains.

data

object[]

required

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Last modified on October 5, 2026

List burned domains

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

{
  "data": [
    {
      "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "domain": "acme-mail.com",
      "provider": "microsoft",
      "managed": true,
      "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "updated_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
      "domain": "imported-acme.com",
      "provider": "google",
      "managed": false,
      "customer_id": "cus_01HZX0C6Z3K4M5N6P7Q8R9S0",
      "updated_at": "2026-05-07T09:30:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/domains/burned?filter=all&per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains/burned",
    "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": {}
  }
}