Skip to main content
GET
/
v1
/
messages
List messages
curl --request GET \
  --url https://senderkit.com/api/v1/messages \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "publicId": "msg_0a1b2c3d4e5f6g7h",
      "templateSlug": "<string>",
      "livemode": true,
      "recipient": "<string>",
      "vars": {},
      "content": {},
      "metadata": {},
      "fromOverride": "<string>",
      "provider": "<string>",
      "providerConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "providerMessageId": "<string>",
      "latencyMs": 123,
      "error": "<string>",
      "timeline": [
        {
          "t": "2023-11-07T05:31:56Z",
          "e": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.senderkit.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

API key with an sk_live_ or sk_test_ prefix.

Query Parameters

​
limit
integer
default:50

Page size (1–200).

Required range: 1 <= x <= 200
​
cursor
string

Opaque pagination cursor from a previous response's nextCursor.

​
status
enum<string>
Available options:
queued,
rendered,
dispatched,
sent,
delivered,
failed,
opted_out
​
channel
enum<string>
Available options:
email,
sms,
push
​
template
string

Filter by template slug.

​
metadata[key]
string

Filter by metadata containment, Stripe-style. E.g. ?metadata[userId]=usr_123. Multiple keys are AND-ed. Values that parse as numbers/booleans are coerced.

​
tail
enum<string>

Set to 1 to receive a Server-Sent Events stream instead of JSON.

Available options:
1

Response

A page of messages.

​
data
object[]
required
​
nextCursor
string | null
required

Cursor for the next page, or null if no more results.