Sign in
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
parent_idstring
message_thread_identifierstring
subjectstring
messagestring
message_htmlstring
message_markdownstring
web_urlstring
referencestring
has_childrenboolean
is_unreadboolean
rawobject

Changes

Changed in 1 of the 34 revisions of this API.33

  • 3bea28547cc733See the full diff
    • ▲

      removed the enum value channel_id from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value channel_ids from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ▲

      removed the enum value root_message_id from the property items/ of the query request parameter fields

      request-parameter-property-enum-value-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog