Common ModelsMessages

/messages

Returns a list of Message objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Query parameters

conversation_idstringOptionalformat: "uuid"
Filter messages by conversation ID.
created_afterdatetimeOptional
If provided, will only return objects created after this datetime.
created_beforedatetimeOptional
If provided, will only return objects created before this datetime.
cursorstringOptional
The pagination cursor value.
include_deleted_databooleanOptional
Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. [Learn more](https://docs.merge.dev/integrations/hris/supported-features/).
include_remote_databooleanOptional

Whether to include the original data Merge fetched from the third-party to produce these models.

include_shell_databooleanOptional

Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

modified_afterdatetimeOptional
If provided, only objects synced by Merge after this date time will be returned.
modified_beforedatetimeOptional
If provided, only objects synced by Merge before this date time will be returned.
order_byenumOptional

Overrides the default ordering for this endpoint. Possible values include: remote_created_at, -remote_created_at.

Allowed values:
page_sizeintegerOptional
Number of results to return per page. The maximum limit is 100.
remote_idstringOptional
The API provider's ID for the given object.
root_messagestringOptional

If provided as ‘true’, will only return root messages (messages without a parent message).

Response

nextstring or null
previousstring or null
resultslist of objects or null
<MergeSupportedFieldsByIntegrationWidget requestType="GET" data="H4sIAAAAAAAAA31T207bQBD9lWoeI18aQopiqaoCoZBIdlowqAgha7w7cTZZe529JGDEv1dOUhpaxMtKO3PmzNk9M8/A0FKh9BNEwOZowYNScZIQQUzGYEHgAdYiwZL2kGx9BB4YV9dKW+LfBUluLjXNIIKwJF2Q7yoxE8TDFh6KylKh0QpVmfC1zJ9t68ADKaol8SFjylX2I6Id0Mcd8p+rCaUwrfwajbFzrVwxv6KVI/MhZ6tHUkmVRelztBge1Pt6R/BerFXOSZIlPkKLI7LE2ifue82trU0UhnOSdbDtG3Bah1SFqK1gkkzY7w2OTgZ9f8+y7f4tK+TXbmexylV+0skKJjN0nThlj0k63iSL4jg5O35Mmpt+0iybZLH83MkK7MRp3J+md73paNidvgPIrr/8Gtyejk4nSYc1571kcbdJUtaNU7bMm3FvcsE2k8ufj0lzdxSPbnpJet6fXKju9OzKxGdXKh4GAXhw6CRE98+Hgf2AxIJpZdTMfkoJS/O2aFy28/T3c3Z+YC382uVSsMD0AiyxURVuTMBUGZbEBYavpNmWNLteOdQU1FXxxwShqlcHIIJkmI5vz98Ow3CNQmIuCSKrHf03wRDdQ674E3jAVLUmbbaaM8HBA02lspQxTWiJZ9s92ccO867mB3mlbFbulmiHMi5fELOZFFW7Vk7L9jSk2/RDy7JyQhP/gRpLsqRbUQ8vDy+/ATRxGIynAwAA" />