List events
Lists past events of one type, newest first, so a tool can poll for new ones. Needs inbox:read, and also contacts:read for contact.opted_out. Read-only; webhooks push the same events without polling.
GET /v1/events
| Permission | inbox:read (all permissions) |
| Risk | Read |
| Idempotency-Key | Not needed (how it works) |
| Safe to repeat | Safe: the call only reads. |
| Rate limit class | read (120 requests per minute per key) |
| Confirmation | None |
| MCP tool | Not available in MCP |
| Since version | 2026-10-25 |
#What it does
- Only reads data. It changes nothing and sends nothing.
#Request
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | integer | no | Items per page (1 to 100, default 20). 1 to 100; default 20 |
cursor | string | no | next_cursor from the previous page. Opaque; only valid with the same filters. up to 300 characters |
type | string | yes | The event type to list. one of: contact.opted_out, message.delivered, message.read, message.failed |
created_after | string | no | Only events after this time (ISO 8601, UTC). up to 40 characters; format date-time |
#Lists, filters and sorting
- Items per page:
limitfrom 1 to 100, default 20 (MCP: default 20, maximum 50). - Next page: send
next_cursorof the answer ascursor. The cursor only works with the same filters. See Pagination. - Filters:
type,created_after. - Sorting: default
created_atdescending;order_byacceptscreated_at.
#Examples
curl "https://api.smartchat.marketing/v1/events?type=message.failed&limit=20" \
-H "Authorization: Bearer $SMARTCHAT_API_KEY"import os
import requests
response = requests.get(
"https://api.smartchat.marketing/v1/events",
headers={"Authorization": "Bearer " + os.environ["SMARTCHAT_API_KEY"]},
params={
"type": "message.failed",
"limit": "20",
},
)
response.raise_for_status()
print(response.json())const response = await fetch("https://api.smartchat.marketing/v1/events?type=message.failed&limit=20", {
method: "GET",
headers: {
Authorization: `Bearer ${process.env.SMARTCHAT_API_KEY}`,
},
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());Response (200):
{
"object": "list",
"data": [
{
"object": "event",
"id": "evt_6f1e2d3c4b5a49788796a5b4c3d2e1f0",
"type": "message.failed",
"created_at": "2026-10-25T09:41:07.412Z",
"data": {
"contact_id": "con_0f8c1a2e4b7d4c3e9a5b6d7e8f901234",
"channel": "whatsapp"
}
}
],
"has_more": false,
"next_cursor": null,
"url": "/v1/events"
}#Response
Status 200. Every response has the headers Request-Id, SmartChat-Version and X-RateLimit-*.
| Name | Type | Description |
|---|---|---|
object | string | Always "list". always list |
data | array of object | The items of this page. up to 100 items |
data[].object | string | Always "event". always event |
data[].id | string | Event ID. |
data[].type | string | Name of the event, the same as in the webhook catalog. one of: contact.opted_out, message.delivered, message.read, message.failed |
data[].created_at | string | When the event happened (with milliseconds). up to 40 characters; format date-time |
data[].data | object | What the event is about. |
data[].data.contact_id | string or null | ID of the contact the event is about. Null if none. |
data[].data.channel | string or null | Channel of the event, for example whatsapp. up to 30 characters |
has_more | boolean | True if another page exists. |
next_cursor | string or null | Pass this as 'cursor' to get the next page; null on the last page. up to 300 characters |
url | string | The path of this list. up to 200 characters |
total_count | integer | Approximate total; may be inaccurate. Only present where cheap to compute. 0 to 1000000000 |
#Errors
| Code | Status | When |
|---|---|---|
invalid_cursor | 400 | The cursor is expired, forged or belongs to other filters. |
missing_parameter | 400 | A required field is missing. |
api_key_expired | 401 | This API key has expired. |
api_key_invalid | 401 | This API key is not valid. |
api_key_revoked | 401 | This API key was revoked. |
authentication_required | 401 | No API key was sent. Send 'Authorization: Bearer <key>'. |
insufficient_scope | 403 | This key lacks a required permission. |
ip_not_allowed | 403 | This IP address is not allowed for this key. |
validation_failed | 422 | A field is not valid. |
rate_limited | 429 | Too many requests. Wait and try again. |
internal_error | 500 | Something went wrong on our side. |
All errors use one format.