messaging
message

List all messages

Changed on
get/messaging/{connection_id}/message

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/messaging/{connection_id}/message
  • Auth: API key in header authorization

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

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

parent_idstring

Represents the ID of the immediate predecessor message in the thread. Identifies a specific message to which the current message directly replies.

message_thread_identifierstring

the opaque identifier for the first message in a thread

subjectstring
messagestring
message_htmlstring
message_markdownstring
web_urlstring
referencestring

eg. RFC822 MessageID

has_childrenboolean
is_unreadboolean
rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property / to the response with the status

  • a29ffd62ac71Revision changes
    • breaking

      the response's body type changed from no type to array for status