logo
Inbox PlacementGet test results
Inbox Placement

Get test results

Returns full details of an inbox placement test including all results data.

curl -X GET "https://api.sendkit.ai/v1/inbox-placement/example_string" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "success": true,
  "data": {
    "_id": "664a1b2c3d4e5f6a7b8c9d40",
    "userId": "user_123",
    "workspaceId": "ws_123",
    "testCode": "IP-1717200000000-a1b2c3d4",
    "testName": "Weekly Deliverability Check",
    "senderMailboxIds": [
      "664a1b2c3d4e5f6a7b8c9d03"
    ],
    "mailboxTypes": [
      "personal_gmail",
      "business_outlook"
    ],
    "subject": "Quick question about your team",
    "emailBody": "<p>Hi there, I wanted to reach out about...</p>",
    "status": "completed",
    "summary": {
      "inbox": 85,
      "spam": 10,
      "missing": 5
    },
    "startedAt": "2024-06-01T10:00:00.000Z",
    "completedAt": "2024-06-01T10:15:00.000Z",
    "createdAt": "2024-06-01T09:59:00.000Z",
    "updatedAt": "2024-06-01T10:15:00.000Z"
  }
}
GET
/v1/inbox-placement/{id}
GET
API Key (header: X-Api-Key)
X-Api-Keystring
Required

Platform API key (sk_user_...) or Workspace API key (sk_...)

Platform API key (sk_user_...) or Workspace API key (sk_...)
Bearer Token
Bearer Tokenstring
Required

API key as Bearer token

API key as Bearer token
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-Api-Keystring
Required

API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)

header
Authorizationstring
Required

Bearer token. API key as Bearer token

Path Parameters

idstring
Required

Resource ID

Responses

successboolean
dataobject