List your text message batches

​

Returns your organization's text message batches, newest first, one page at a time. Follow next_cursor for the next page. Each item is the same whole-batch progress the single-batch read returns.

Query Parameters

  • cursor
    Type: stringnullable

    The next_cursor from the previous page. Omit it for the first page.

  • limit
    Type: integer
    min:  
    1
    max:  
    200

    How many batches to return per page.

Responses

  • application/json
  • application/json
Request Example for get/v1/text-message-batches
curl '/v1/text-message-batches?limit=50' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "items": [
    {
      "id": "01M0C7XKQ3ZT9V4W8N2RGA5HDB",
      "status": "in_progress",
      "from_phone_number": "string",
      "total": 0,
      "counts": {
        "queued": 0,
        "canceled": 0,
        "sent": 0,
        "delivered": 0,
        "delivery_unconfirmed": 0,
        "failed": 0
      },
      "created_at": "2026-09-24T21:09:12.163Z",
      "completed_at": "2026-09-24T21:09:12.163Z"
    }
  ],
  "next_cursor": "string"
}

Successful Response