List Ticket Messages

Return the messages of a ticket in one call, instead of reading them one by one with GET /messages/{messageId}. These are the messages whose ids the ticket lists in messages_ids, each one exactly as GET /messages/{messageId} returns it, ordered by id (the order eDesk received them in, oldest first). created_at can be out of that order for a message eDesk imported later than it was sent.

Pagination. Use page and itemsPerPage (at most 100 messages a page); paginator.totalItemsCount is the number of messages on the ticket. Unlike the other lists, a page past the last one returns no messages rather than the last page again: stop at the first empty page, or once you have totalItemsCount messages. Almost every ticket fits on one page of 100.

Needs read access to Messages. A ticket that does not exist returns a 404, and one the token cannot access a 401, as GET /tickets/{ticketId} does.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Ticket ID whose messages to fetch

Query Params
include
array of strings

Optional fields to add to every message, comma separated, e.g. include=respond_by,attachments.valid_until (or include[]=respond_by&include[]=attachments.valid_until). The default fields are always returned. The same optional fields as GET /messages/{messageId}; values that are not listed here are ignored.

include
Allowed:
integer
≥ 1

Page number, starting at 1. A value below 1 is read as 1, and a page past the last one returns no messages.

integer
1 to 100
Defaults to 20

Number of messages per page. A value above 100 is read as 100; a value below 1 as the default.

Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json