Skip to main content
GET
/
domains
/
forwarding
/
{id}
Retrieving a forwarding job
curl --request GET \
  --url https://api.peeker.ai/api/partner/v1/domains/forwarding/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "fwj_01HZX0FW1A2B3C4D5E6F7G8H",
    "status": "completed",
    "completed_count": 3,
    "failed_count": 0,
    "forwarding_url": "https://acme.com",
    "completed": [
      "acme-mail.com",
      "team-acme.com",
      "news-acme.com"
    ],
    "failed": [],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:01:30Z"
  }
}

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.

Path Parameters

​
id
string
required

The forwarding job ID, e.g. fwj_01HZX.

Example:

"fwj_01HZX"

Response

200 - application/json

Current state of a forwarding job.

​
data
object
required
Last modified on May 14, 2026