Skip to main content
GET
/
messages
/
{message_id}
Get message
curl --request GET \
  --url https://api.courier.com/messages/{message_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "status": "CANCELED",
  "enqueued": 123,
  "sent": 123,
  "delivered": 123,
  "opened": 123,
  "clicked": 123,
  "recipient": "<string>",
  "event": "<string>",
  "notification": "<string>",
  "error": "<string>",
  "reason": "BOUNCED",
  "providers": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
message_id
string
required

A unique identifier associated with the message you wish to retrieve (results from a send).

Response

​
id
string
required

A unique identifier associated with the message you wish to retrieve (results from a send).

​
status
enum<string>
required

The current status of the message.

Available options:
CANCELED,
CLICKED,
DELAYED,
DELIVERED,
DIGESTED,
ENQUEUED,
FILTERED,
OPENED,
ROUTED,
SENT,
SIMULATED,
THROTTLED,
UNDELIVERABLE,
UNMAPPED,
UNROUTABLE
​
enqueued
integer
required

A UTC timestamp at which Courier received the message request. Stored as a millisecond representation of the Unix epoch.

​
sent
integer
required

A UTC timestamp at which Courier passed the message to the Integration provider. Stored as a millisecond representation of the Unix epoch.

​
delivered
integer
required

A UTC timestamp at which the Integration provider delivered the message. Stored as a millisecond representation of the Unix epoch.

​
opened
integer
required

A UTC timestamp at which the recipient opened a message for the first time. Stored as a millisecond representation of the Unix epoch.

​
clicked
integer
required

A UTC timestamp at which the recipient clicked on a tracked link for the first time. Stored as a millisecond representation of the Unix epoch.

​
recipient
string
required

A unique identifier associated with the recipient of the delivered message.

​
event
string
required

A unique identifier associated with the event of the delivered message.

​
notification
string
required

A unique identifier associated with the notification of the delivered message.

​
providers
object[] | null
​
error
string | null

A message describing the error that occurred.

​
reason
enum<string>

The reason for the current status of the message.

Available options:
BOUNCED,
FAILED,
FILTERED,
NO_CHANNELS,
NO_PROVIDERS,
OPT_IN_REQUIRED,
PROVIDER_ERROR,
UNPUBLISHED,
UNSUBSCRIBED