List events

GET /v1/events

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Query parameters

Name	Type	Required	Description
`limit`	integer	No	Default 25. Maximum 100.
`cursor`	string	No
`type`	string	No	Example: `message.delivered`.

Results are paged. When has_more is true, pass next_cursor from the response as cursor to fetch the next page.

Responses

Status	Meaning	Body
200	Events, newest first	Page of `Event`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: each item in `data` (Event)

The body is a page: data (the array), has_more, and next_cursor (null on the last page).

Field	Type	Description
`id`	string	Example: `evt_a1B2c3D4e5F6g7H8`.
`object`	`event`
`type`	`message.sent`, `message.delivered`, `message.failed`, `message.received`, `message.opted_out`, `message.opted_in`, `message.help_requested`, `message.blocked`, `broadcast.complete`, `number.purchased`, `number.released`, `number.sender_updated`, `verification.sent`, `verification.approved`, `verification.failed`, `verification.blocked`, `verification.sent_to_opted_out`, `registration.updated`, `deliverability.degraded`, `spend.threshold_reached`, `credits.low`, `credits.depleted`, `credits.topped_up`, `credits.auto_recharge_failed`, `automation.run.started`, `automation.run.completed`, `automation.run.failed`, `schedule.occurrence_skipped`, `schedule.paused`, `batch.created`, `batch.paused`, `batch.resumed`, `batch.canceled`, `batch.retried`, `batch.complete`
`created_at`	string (date-time)
`data`	object

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X GET "https://api.joinsimplesms.com/v1/events?limit=10" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

const events = await sms.events.list({ limit: 10 });

for (const event of events.data) console.log(event.type, event.id);

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

events = client.events.list(limit=10)

for event in events["data"]:
    print(event["type"], event["id"])