Messages
List messages
A paginated list of messages, newest first. Scope to a single recipient using the nested /people/{person_id}/messages collection.
Authorization
bearerAuth AuthorizationBearer <token>
In: header
Query Parameters
include?string
Comma-separated list of relationships to include. Allowed values are resource-specific; consult the operation for the allowlist.
sort?string
Comma-separated list of attributes to sort by. Prefix with - for
descending order (-created_at,family_name).
page?
Offset pagination parameters.
filter?
Keys take the form filter[<attribute>_<predicate>]=<value>, repeatable per query.
Common predicates by attribute type:
- String / text / uuid:
eq,not_eq,cont,not_cont,matches,start,end,present,blank,null,not_null,in,not_in
Example: ?filter[subject_cont]=invoice
fields[messages]?array<>
Sparse-fieldset selection.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/messages"{ "data": [ { "type": "messages", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "attributes": { "subject": "string", "body": "string", "from_address": "string", "raw_text": "string", "raw_html": "string", "raw_body": "string", "headers": "string", "sanitized_body": "string", "raw_headers": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }, "relationships": { "from": { "data": { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } }, "to": { "data": { "type": "people", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08" } } }, "links": { "self": { "href": "/messages/7247ad7d-9275-454b-9e3a-0570e403739e" }, "messages_preview": { "href": "https://files.wicketcloud.com/messages/7247ad7d-9275-454b-9e3a-0570e403739e/preview.html" } }, "meta": {} } ], "meta": { "page": { "total_items": 0, "total_pages": 0, "number": 0, "size": 0 } }}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}{ "errors": [ { "status": 0, "title": "string", "source": { "pointer": "string", "parameter": "string" }, "meta": { "error": "string", "field": "string" } } ]}