logo
Inbox PlacementList inbox placement tests
Inbox Placement

List inbox placement tests

Returns a paginated list of inbox placement tests for the workspace, sorted by most recent first. Includes test name, status, summary results, and timestamps.

curl -X GET "https://api.sendkit.ai/v1/inbox-placement?page=25&limit=42&cursor=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",
      "testName": "Inbox Placement Test 6/1/2024",
      "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"
    },
    {
      "_id": "664a1b2c3d4e5f6a7b8c9d41",
      "testName": "Weekly Check",
      "status": "pending",
      "summary": null,
      "startedAt": null,
      "completedAt": null,
      "createdAt": "2024-06-08T09:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 5,
    "page": 1,
    "limit": 20,
    "pages": 1
  }
}
GET
/v1/inbox-placement
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
query
limitinteger
Min: 1 • Max: 100
query
cursorstring

Cursor ID for cursor-based pagination (use instead of page for large datasets)

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

Query Parameters

cursorstring

Cursor ID for cursor-based pagination (use instead of page for large datasets)

Responses

successboolean
dataarray
paginationobject