Request
curl https://api.beaconbox.eu/api/v1/messages \
-H "Authorization: Bearer $BEACONBOX_API_KEY"client.messages.list() # or client.messages.iterate() to follow cursors$client->messages->list() // or ->each() to follow cursorsQuery parameters
| Name | Type | Description |
|---|---|---|
recipient_email | string | null | |
limit | integer | |
cursor | string | null |
Response
Returns 200.
| Field | Type | Description |
|---|---|---|
items | object[] | |
next_cursor | string | null |
Errors
Failures are { "error_code": "..." } with a stable dotted code. See Errors for the codes worth branching on and the three outcomes that look like failures and are not.
