Sign in
courier

List Messages

Lists all messages by given status and recipient.

get/admin/courier/messages

Query parameters

per_pageinteger

Items per Page

This is the number of items per page.

pageinteger

Pagination Page

This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.

For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.

status'queued' | 'sent' | 'processing' | 'abandoned'

A Message's Status

Status filters out messages based on status. If no value is provided, it doesn't take effect on filter.

recipientstring

Recipient filters out messages based on recipient. If no value is provided, it doesn't take effect on filter.

Response

Paginated Courier Message List Response

bodystring
created_atstring date-time

CreatedAt is a helper struct field for gobuffalo.pop.

idstring uuid
recipientstring
send_countinteger
status'queued' | 'sent' | 'processing' | 'abandoned'

A Message's Status

subjectstring
template_type'recovery_invalid' | 'recovery_valid' | 'recovery_code_invalid' | 'recovery_code_valid' | 'verification_invalid' | 'verification_valid' | 'verification_code_invalid' | 'verification_code_valid' | 'otp' | 'stub'
type'email' | 'phone'

It can either be email or phone

updated_atstring date-time

UpdatedAt is a helper struct field for gobuffalo.pop.

Example response

[
  {
    "updated_at": "2000-01-23T04:56:07.000+00:00",
    "subject": "subject",
    "recipient": "recipient",
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "send_count": 0,
    "template_type": "recovery_invalid",
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "body": "body",
    "type": null,
    "status": null
  }
]

Changes