Peeker Partner API

GET

domains

{id}

Retrieving a domain

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

{
  "data": {
    "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
    "domain": "acme-mail.com",
    "category": "connected",
    "status": "active",
    "provider": "google",
    "user_id": "usr_01HZX0C6Z3K4M5N6P7Q8R9S0",
    "order_id": "ord_01HZX0OR1A2B3C4D5E6F7G8H",
    "usable_for": [
      "google",
      "microsoft"
    ],
    "forwarding_url": "https://acme.com",
    "created_at": "2026-05-08T12:00:00Z"
  }
}

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.

Path Parameters

string

required

The domain ID, e.g. dom_01HZX.

Response

200 - application/json

A domain.

data

object

required

Show child attributes

Last modified on June 29, 2026

Finding a Cloudflare importLook up import jobs by domain when you no longer have the `imp_...` job ID. By default the response only includes the requested domains. You must pass `domains=...`; this is not a bare list endpoint. Use `include_group=true` to return the full matching nameserver group.

Retrieving a domain

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

{
  "data": {
    "id": "dom_01HZX0D01A2B3C4D5E6F7G8H",
    "domain": "acme-mail.com",
    "category": "connected",
    "status": "active",
    "provider": "google",
    "user_id": "usr_01HZX0C6Z3K4M5N6P7Q8R9S0",
    "order_id": "ord_01HZX0OR1A2B3C4D5E6F7G8H",
    "usable_for": [
      "google",
      "microsoft"
    ],
    "forwarding_url": "https://acme.com",
    "created_at": "2026-05-08T12:00:00Z"
  }
}