Peeker Partner API

GET

domains

burned

replace

{id}

results

List replace results

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

{
  "data": [
    {
      "status": "completed",
      "domain": "acme-mail.com",
      "replacement_domain": "acme-fresh.com",
      "swap_id": "swp_01HZX0SW1A2B3C4D5E6F7G8H"
    },
    {
      "status": "failed",
      "domain": "bad-acme.com",
      "replacement_domain": "bad-acme-fresh.com",
      "reason": "This domain already has a swap in progress."
    },
    {
      "status": "pending",
      "domain": "team-acme.com",
      "replacement_domain": "team-acme-2.com"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/domains/burned/replace/brj_01HZX/results?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains/burned/replace/brj_01HZX/results",
    "per_page": 25,
    "returned": 3
  }
}

{
  "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_…).

Path Parameters

string

required

The replacement job ID, e.g. brj_01HZX.

Example:

"brj_01HZX"

Query Parameters

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 replacement results.

data

(Pending replacement · object | Completed replacement · object | Failed replacement · object)[]

required

Pending replacement
Completed replacement
Failed replacement

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Last modified on October 5, 2026

List replace results

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

{
  "data": [
    {
      "status": "completed",
      "domain": "acme-mail.com",
      "replacement_domain": "acme-fresh.com",
      "swap_id": "swp_01HZX0SW1A2B3C4D5E6F7G8H"
    },
    {
      "status": "failed",
      "domain": "bad-acme.com",
      "replacement_domain": "bad-acme-fresh.com",
      "reason": "This domain already has a swap in progress."
    },
    {
      "status": "pending",
      "domain": "team-acme.com",
      "replacement_domain": "team-acme-2.com"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/domains/burned/replace/brj_01HZX/results?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/domains/burned/replace/brj_01HZX/results",
    "per_page": 25,
    "returned": 3
  }
}

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

Authorizations

Path Parameters

Query Parameters

Response