v5

latestOpenAPI 3.0.02026-08-017841,2603.2 MB
messaging
message

List all messages

get/messaging/{connection_id}/message

Path parameters

connection_idstring required

ID of the connection

Query parameters

limitnumber
offsetnumber
updated_gtestring

Return only results whose updated date is equal or greater to this value (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

sortstring
orderstring
querystring

Query string to search. eg. email address or name

parent_idstring

The parent ID to filter by

channel_idstring

The channel ID to filter by. You can also use these aliases; INBOX, SENT or DRAFT (reference to MessagingChannel)

start_gtestring

The start date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

end_ltstring

The end date to filter by (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

expandboolean

Whether to flatten grouped or recurring items into individual entries.

user_idstring

The user/employee ID to filter by (reference to HrisEmployee)

typestring
user_mentioned_idstring

The user/employee ID to filter by

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Response

Successful

idstring
created_atstring date-time
updated_atstring date-time
channel_idstring
channel_idsstring[]

@deprecated; use channels instead

parent_idstring
root_message_idstring
message_thread_identifierstring
subjectstring
messagestring
message_htmlstring
message_markdownstring
web_urlstring
referencestring
has_childrenboolean
is_unreadboolean
rawobject