List Messages
listMessagesList Messages
Retrieve recent project outreach messages for reporting or auditing with optional calendar bounds on a chosen message datetime column.
List endpoints are paginated. Use the page and limit query parameters to paginate through results (at most 30 records per page). Check the pagination object in the response (current_page, last_page, total) to determine if more pages exist and whether to continue fetching.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Which page of results to return (1 is the first page). Omit this field or use 1 for the first page. Accepts minimum 1. | |
| limit | No | Maximum number of records to return. Accepts an integer from 1 to 30. | |
| status | No | Filter messages by delivery status. | |
| channel | No | Filter messages by delivery channel. | |
| date_to | No | Inclusive upper calendar date (YYYY-MM-DD) for the column chosen by date_key; must be on or after date_from when both bounds are provided. | |
| date_key | No | Message datetime column paired with date_from and date_to (defaults to created_at when omitted). | |
| sort_dir | No | Sort direction: asc or desc. | |
| sort_key | No | Message timestamp field to sort by. | |
| date_from | No | Inclusive lower calendar date (YYYY-MM-DD) for the column chosen by date_key, defaulting to created_at when date_key is omitted. | |
| template_slug | No | Filter messages by template slug prefix. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Short code or application-level status code for this resource. | |
| data | No | Response payload for the request. | |
| success | No | Indicates whether the request completed successfully. | |
| pagination | No | Pagination metadata for list responses. |