List message logs /api/sms/logs

GET {BASE_URL}/api/sms/logs

Returns your organisation's sent messages, newest first, paginated.

Query params (all optional)

Param	Description
`q`	Free-text search across status, recipient, and body.
`status`	Filter by `delivered`, `sent`, or `failed`.
`recipient`	Filter by a specific phone number.
`message_id`	Filter by a message UUID (returns the single message).
`from`, `to`	Date range (see Date ranges). Defaults to last 30 days.
`page`, `perPage`	Pagination (see Pagination).

Example

Success — 200 OK

{
  "success": true,
  "message": "Sms logs fetched successfully",
  "data": [
    {
      "message_id": "a3d5f0c1-9e22-4b7a-8f1c-2d6e9b0a4c77",
      "status": "delivered",
      "message_type": "one_way",
      "recipient": "+2348120191228",
      "message": "Your OTP is 4821",
      "cost": "4.00",
      "operator": "MTN",
      "error_message": null,
      "template": null,
      "otp": "Your OTP is 4821",
      "date": "2026-06-22T09:14:55.000Z",
      "created_at": "2026-06-22T09:14:55.000Z",
      "delivered_at": "2026-06-22T09:15:01.000Z"
    }
  ],
  "meta": {
    "current_page": 1, "next_page": null, "previous_page": null,
    "per_page": 20, "total": 1, "last_page": 1
  }
}

See the message object appendix for field meanings.

curl --location 'https://prod.your-api-server.com/api/sms/logs?q=&status=delivered&recipient%09=undefined&message_id=undefined&from=2026-06-01&to=2026-06-22&page=1&perPage=20' \ --header 'x-api-key: {{x-api-key}}'

{ "success": true, "message": "Sms logs fetched successfully", "data": [ { "message_id": "a3d5f0c1-9e22-4b7a-8f1c-2d6e9b0a4c77", "status": "delivered", "message_type": "one_way", "recipient": "+2348120191228", "message": "Your OTP is 4821", "cost": "4.00", "operator": "MTN", "error_message": null, "template": null, "otp": "Your OTP is 4821", "date": "2026-06-22T09:14:55.000Z", "created_at": "2026-06-22T09:14:55.000Z", "delivered_at": "2026-06-22T09:15:01.000Z" } ], "meta": { "current_page": 1, "next_page": null, "previous_page": null, "per_page": 20, "total": 1, "last_page": 1 } }

Request

Responses