InboxList conversations

List conversations

Returns paginated conversations (campaign leads that have replies). Each conversation includes lead info, campaign info, AI mode/capability flags, 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&cursor=664a1b2c3d4e5f6a7b8c9d0e&limit=25" \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY"
{
  "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",
      "aiMode": "active",
      "autoReplyEnabled": true,
      "followupEnabled": true,
      "aiAgentActive": true,
      "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
      },
      "isRead": false,
      "unreadCount": 1,
      "messageCount": 4
    }
  ],
  "pagination": {
    "limit": 20,
    "total": 25,
    "hasMore": true,
    "nextCursor": "664a1b2c3d4e5f6a7b8c9d0e"
  }
}
GET
/v1/inbox
GET
Base URLstring

Target server for requests. Edit to use your own host.

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_...)
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
cursorstring

Cursor for pagination - use the nextCursor value from the previous response to fetch the next page

query
limitinteger

Items per page (default 25, max 100)

Min: 1 • Max: 100
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_...)

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 for pagination - use the nextCursor value from the previous response to fetch the next page

Example:
664a1b2c3d4e5f6a7b8c9d0e
limitinteger

Items per page (default 25, max 100)

Responses

successboolean
dataarray
paginationobject