List messages

List messages

Query Parameters
per_page number Possible values: value ≤ 100 Number of items to return per page (max 100)
offset number Number of items to skip (for pagination)
created_before date-time Filter items created before this date (ISO 8601 format)
created_after date-time Filter items created after this date (ISO 8601 format)
updated_before date-time Filter items updated before this date (ISO 8601 format)
updated_after date-time Filter items updated after this date (ISO 8601 format)
channel string Possible values: [CHROME_WIDGET, FORM, FRESHDESK, HUBSPOT, INTERCOM, MAIL, NOTE, SALESFORCE, SHEET, SLACK, ZENDESK, MS_TEAMS, PUBLIC_API, HFC, AIRCALL, CLAAP, GONG, MODJO, PRAIZ] Filter messages by channel
requesterId string Filter messages by requester ID
hasFeedback boolean Filter messages by whether they have feedback linked or not
customInboxId string Filter messages by custom inbox ID

Responses

200 Return a paginated list of messages Schema — OPTIONAL messages object[] Array of messages id string Unique identifier of the message clientId string Client identifier receivedAt date-time — OPTIONAL Date when the message was received createdAt date-time Creation date of the message updatedAt date-time Last update date of the message integrationUrl string — OPTIONAL When you import messages from an external source (e.g.: Intercom) into Harvestr, this is the URL of the message in the source tool integrationId string — OPTIONAL When you import messages from an external source (e.g.: Intercom) into Harvestr, this is the message ID in the source tool title string Title of the message content string Content of the message channel string Possible values: [CHROME_WIDGET, FORM, FRESHDESK, HUBSPOT, INTERCOM, MAIL, NOTE, SALESFORCE, SHEET, SLACK, ZENDESK, MS_TEAMS, PUBLIC_API, HFC, AIRCALL, CLAAP, GONG, MODJO, PRAIZ] Channel through which the message was received read boolean Whether the message has been read updated boolean Whether the message has been updated archived boolean Whether the message is archived bin boolean Whether the message is in the bin assigneeId string — OPTIONAL Identifier of the assignee requesterId string Identifier of the requester submitterId string Identifier of the submitter labels string[] Labels associated with this message