Skip to main content
GET
/
v1
/
api
/
messages
List messages with pagination and filtering
curl --request GET \
  --url https://backend.blooio.com/v1/api/messages \
  --header 'Authorization: Bearer <token>'
{
  "messages": [
    {
      "message_id": "gK2Ig_XGR2M6UkSgmT9FK",
      "organization_id": "org_xyz",
      "external_id": "+15551234567",
      "direction": "outbound",
      "text_length": 23,
      "attachments_count": 0,
      "time_sent": 1703123457370,
      "status": "delivered",
      "metadata": {
        "ticket_id": "TCK-123"
      },
      "protocol": "imessage"
    }
  ],
  "pagination": {
    "total": 1543,
    "limit": 100,
    "offset": 0,
    "returned": 100,
    "has_more": true
  }
}

Authorizations

​
Authorization
string
header
required

API key must be provided in the Authorization header as Bearer YOUR_API_KEY.

Query Parameters

​
limit
integer
default:100

Number of messages to return per page (max 1000).

Required range: 1 <= x <= 1000
​
offset
integer
default:0

Number of messages to skip for pagination.

Required range: x >= 0
​
direction
enum<string>

Filter by message direction.

Available options:
inbound,
outbound
​
status
enum<string>

Filter by message status.

Available options:
pending,
queued,
sent,
delivered,
failed,
cancelled,
cancellation_requested
​
contact
string

Filter by phone number or email (external_id).

​
sort
enum<string>
default:desc

Sort order by time_sent. 'desc' returns newest first, 'asc' returns oldest first.

Available options:
asc,
desc

Response

List of messages with pagination metadata.

​
messages
object[]

Array of message objects.

​
pagination
object

Pagination metadata.