Skip to main content
GET
/
swaps
Listing domain swaps
curl --request GET \
  --url https://api.peeker.ai/api/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/api/partner/v1/swaps?per_page=25",
    "next": null
  },
  "meta": {
    "path": "https://api.peeker.ai/api/partner/v1/swaps",
    "per_page": 25,
    "returned": 2
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.peeker.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
default:Bearer pk_test_<your-test-key>
required

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Query Parameters

user_id
string

Filter to swaps for one customer.

Example:

"usr_01HZX0C6Z3K4M5N6P7Q8R9S0"

order_id
string

Filter to swaps within one order.

Example:

"ord_01HZX0OR1A2B3C4D5E6F7G8H"

domain_id
string

Filter to swaps that retired or replaced one domain.

Example:

"dom_01HZX0D01A2B3C4D5E6F7G8H"

status
enum<string>

Filter to one swap status.

Available options:
created,
in_progress,
completed,
failed,
action_required
per_page
integer
default:25

Page size; default 25, max 100.

Required range: 1 <= x <= 100
page_token
string

Opaque token returned in links.next. Do not parse or build by hand.

Response

200 - application/json

A page of swaps.

data
object[]
required
meta
object
Last modified on May 14, 2026