Peeker Partner API

GET

/

swaps

List swaps

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

{
  "data": [
    {
      "id": "swp_01HZX0SW1A2B3C4D5E6F7G8H",
      "type": "premium",
      "domain_id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "replacement_domain": "acme-fresh.com",
      "status": "in_progress",
      "created_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "swp_01HZX0SW3A2B3C4D5E6F7G8H",
      "type": "user_names",
      "domain_id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
      "replacement_domain": null,
      "status": "completed",
      "created_at": "2026-05-07T15:42:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/swaps?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/swaps",
    "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": {}
  }
}

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

customer_id

string

Filter to swaps for one customer.

Pattern: ^cus_

Example:

"cus_01HZX0C6Z3K4M5N6P7Q8R9S0"

order_id

string

Filter by order (ord_…).

Example:

"ord_01HZX0OR1A2B3C4D5E6F7G8H"

domain_id

string

Filter by domain (dom_…).

Example:

"dom_01HZX0D01A2B3C4D5E6F7G8H"

status

enum<string>

Filter by status.

Available options:

created,

in_progress,

completed,

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 swaps.

data

object[]

required

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Last modified on October 5, 2026

List swaps

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

{
  "data": [
    {
      "id": "swp_01HZX0SW1A2B3C4D5E6F7G8H",
      "type": "premium",
      "domain_id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
      "replacement_domain": "acme-fresh.com",
      "status": "in_progress",
      "created_at": "2026-05-08T12:00:00Z"
    },
    {
      "id": "swp_01HZX0SW3A2B3C4D5E6F7G8H",
      "type": "user_names",
      "domain_id": "dom_01HZX0D02A2B3C4D5E6F7G8H",
      "replacement_domain": null,
      "status": "completed",
      "created_at": "2026-05-07T15:42:00Z"
    }
  ],
  "links": {
    "first": "https://api.peeker.ai/partner/v1/swaps?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/partner/v1/swaps",
    "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": {}
  }
}

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