Returns a list of all message UIDs within your project. The results are limited to avoid excessive processing time, so itering over multiple pages of them may be necessary.
Request Fields
These are passed in as arguments at the top level of the request.
| Key | Type | Description |
|---|---|---|
| page | integer Optional |
Page of results to retrieve. Default: 1 |
| per_page | integer Optional |
How many results to return per page. Default: 250 |
Request Example
{
"api_key": "PROJECT_API_KEY",
"arguments": {
"page": 2
}
}Response 200 OK
{
"response": {
"status": "ok",
"uid": null
},
"data": {
"a4a80631-6128-42d4-81a6-b2a763ad536d": {
"project_id": 1019,
"template": "example_template",
"transmissions_total": 10023,
"transmissions_failed": 49,
"transmissions_completed": 9974,
"created_at": "UTC_DATE_CREATED",
"will_purge_at": "UTC_DATE_TO_PURGE"
}
}
}If there were no messages sent within the last 14-28 days (depending on plan), you will receive the following:
{
"response": {
"status": "ok",
"uid": null
}
}