List SMS messages

GET/api/v1/sms

GET /sms

curl -X GET 'https://www.unitpost.com/api/v1/sms' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "sms",
      "id": "id_123",
      "to": "customer@example.com",
      "from": "you@yourdomain.com",
      "direction": "outbound",
      "status": "queued",
      "type": "transactional",
      "body": "string",
      "segments": 0,
      "country": "string",
      "scheduled_at": "2026-01-01T00:00:00.000Z",
      "last_error": "string",
      "error": {
        "code": "out_of_reach",
        "message": "string"
      },
      "created_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve your workspace's SMS messages (outbound and inbound), newest-first and cursor-paginated. Use a message's id with Retrieve an SMS message to read its delivery state. Requires the sms:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

Response · 200 fields14 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`to`required	string	—
`from`required	object	—
`direction`required	enumoutbound \| inbound	—
`status`required	enumqueued \| scheduled \| sending \| sent \| delivered \| failed \| suppressed \| canceled \| received	—
`type`required	enumtransactional \| marketing	—
`body`required	object	—
`segments`required	integer	—
`country`required	object	—
`scheduled_at`required	object	—
`last_error`required	object	Legacy free-text error. Prefer `error.code`.
`error`required	object	Set on `suppressed` messages: the stable skip reason and its sentence. Null otherwise.
`created_at`required	string	—

200401403422

List SMS messages

List SMS messages

Search docs and guides