Get Message

Returns a single message by its reference_id, including its current status and timestamps. status is one of pending, queued, sending, sent, delivered, failed; sent_at and delivered_at are null until reached.

GET/api/v1/messages/:reference_id
X-API-Key

Path parameters

FieldTypeRequiredDescription
reference_idstringrequiredThe message reference ID (UUID) returned when the message was created

Example response

{
  "success": true,
  "data": {
    "api_key_id": 7,
    "api_key_name": "Production",
    "api_key_prefix": "uk_live_ab12",
    "app_name": "MyApp",
    "reference_id": "550e8400-e29b-41d4-a716-446655440000",
    "to_number": "+99361394459",
    "content": "Your code is 482153",
    "status": "delivered",
    "sent_at": "2026-04-21T11:20:02Z",
    "delivered_at": "2026-04-21T11:20:08Z",
    "created_at": "2026-04-21T11:20:00Z"
  }
}

Errors

CodeDescription
400 BAD_REQUESTreference_id is not a valid UUID
401 UNAUTHORIZEDAPI key missing or invalid
404 NOT_FOUNDMessage does not exist or belongs to another account
429 RATE_LIMITEDToo many requests — retry after Retry-After