List Messages
GET {{baseUrl}}/admin/courier/messages?page_size=250&page_token=<string>&status=processing&recipient=<string>
Lists all messages by given status and recipient.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
page_size | number | Items per Page |
This is the number of items per page to return.
For details on pagination please head over to the pagination documentation. |
| page_token | string | | Next Page Token
The next page token.
For details on pagination please head over to the pagination documentation. |
| status | string | | Status filters out messages based on status.
If no value is provided, it doesn't take effect on filter. |
| recipient | string | | Recipient filters out messages based on recipient.
If no value is provided, it doesn't take effect on filter. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"id":"\u003cuuid\u003e","status":"processing","type":"email","recipient":"\u003cstring\u003e","body":"\u003cstring\u003e","subject":"\u003cstring\u003e","template_type":"login_code_valid","send_count":"\u003clong\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","channel":"\u003cstring\u003e","dispatches":[{"id":"\u003cuuid\u003e","message_id":"\u003cuuid\u003e","status":"success","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","error":{}},{"id":"\u003cuuid\u003e","message_id":"\u003cuuid\u003e","status":"success","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","error":{}}]},{"id":"\u003cuuid\u003e","status":"abandoned","type":"phone","recipient":"\u003cstring\u003e","body":"\u003cstring\u003e","subject":"\u003cstring\u003e","template_type":"recovery_valid","send_count":"\u003clong\u003e","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","channel":"\u003cstring\u003e","dispatches":[{"id":"\u003cuuid\u003e","message_id":"\u003cuuid\u003e","status":"success","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","error":{}},{"id":"\u003cuuid\u003e","message_id":"\u003cuuid\u003e","status":"success","created_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","error":{}}]}]