List Organization Messages
GET
https://api.ziett.co/c/v1/messages
Last modified:2026-03-22 10:48:32
Search (q)
q parameter to perform a keyword search. It matches against:Filtering options
status=sent&status=failed).| Parameter | Type | Description |
|---|---|---|
status | enum | Filter by delivery state: PENDING, SENT, DELIVERED, FAILED, UNDELIVERED. |
channel_type | enum | Filter by channel: SMS, WHATSAPP. |
contact_id | uuid | Filter messages sent to a specific contact from your audience. |
campaign_id | uuid | Filter messages belonging to a specific batch campaign. |
remitter_id | uuid | Filter by the Sender ID (Remitter) used for delivery. |
created_at__ge | datetime | Start of the date range (ISO 8601). |
created_at__le | datetime | End of the date range (ISO 8601). |
Pagination & Sorting
30, maximum is 200 records per page.order (asc, desc) and order_by (created_at, updated_at).Request
Query Params
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.ziett.co/c/v1/messages?q=&size=30&page=1&order=desc&order_by=created_at&contact_id=&campaign_id=&status=&trigger_source=&channel_type=&channel_destination=&sms_remitter_id=&created_at__ge=&created_at__le=' \
--header 'X-API-KEY: <api-key>'Response Response Example
200 - Example 1
{
"entries": [
{
"id": "string",
"updated_at": "2019-08-24T14:15:22.123Z",
"created_at": "2019-08-24T14:15:22.123Z",
"organization_id": "string",
"campaign_id": "string",
"contact_id": "string",
"sms_remitter_id": "string",
"sms_remitter": {
"name": "Ziett"
},
"external_id": "string",
"cost": "3423.23",
"billing_account_id": "string",
"channel_type": "SMS",
"channel_destination": "UNITEL",
"provider_id": "string",
"e164_format": "+244990090990",
"content": "string",
"trigger_source": "API_CLIENT",
"error_code": "INVALID_PHONE_NUMBER",
"is_refunded": true,
"status": "PENDING",
"contact": {
"id": "string",
"updated_at": "2019-08-24T14:15:22.123Z",
"created_at": "2019-08-24T14:15:22.123Z",
"name": "string",
"email": "user@example.com",
"e164_format": "+244990090990",
"organization_id": "string"
},
"campaign": {
"id": "string",
"updated_at": "2019-08-24T14:15:22.123Z",
"created_at": "2019-08-24T14:15:22.123Z",
"name": "string",
"status": "DRAFT"
}
}
],
"total": 0,
"page": 1,
"size": 1,
"pages": 0
}Modified at 2026-03-22 10:48:32