logo
InboxList conversations
Inbox

List conversations

Returns paginated conversations (campaign leads that have replies). Each conversation includes lead info, campaign info, last message preview, and message count. Supports filtering by unread status, AI tag, campaign, and search (matches lead email/name).

curl -X GET "https://api.sendkit.ai/v1/inbox?status=unread&tag=example_string&campaign_id=example_string&search=example_string&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": "664a1b2c3d4e5f6a7b8c9d0e",
      "lead": {
        "_id": "664a1b2c3d4e5f6a7b8c9d01",
        "email": "jane@example.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "companyName": "Acme Inc"
      },
      "campaign": {
        "_id": "664a1b2c3d4e5f6a7b8c9d02",
        "name": "Q1 Outreach"
      },
      "status": "active",
      "aiTag": "interested",
      "tags": [
        "vip"
      ],
      "repliedAt": "2024-06-01T14:30:00.000Z",
      "lastMessage": {
        "content": "Thanks for reaching out! I'd love to learn more about...",
        "from": "jane@example.com",
        "receivedAt": "2024-06-01T14:30:00.000Z",
        "isFromLead": true,
        "read": false
      },
      "messageCount": 4
    }
  ],
  "pagination": {
    "total": 25,
    "page": 1,
    "limit": 20,
    "pages": 2
  }
}
GET
/v1/inbox
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
statusstring

Filter by status. Use unread to show only conversations with unread lead replies.

Options: unread
query
tagstring

Filter by AI tag value (e.g. "interested", "not_interested").

query
campaign_idstring

Filter by campaign ID.

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

statusstring

Filter by status. Use unread to show only conversations with unread lead replies.

Allowed values:unread
tagstring

Filter by AI tag value (e.g. "interested", "not_interested").

campaign_idstring

Filter by campaign ID.

cursorstring

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

Responses

successboolean
dataarray
paginationobject