/messages

GET

/messages

GET

/api/chat/v1/messages

curl -G https://api.merge.dev/api/chat/v1/messages \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>" \
     -d include_remote_data=true

200Retrieved

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "id": "m1f2d8a4-9f7a-4e2b-8e2f-123456789abc",
      "remote_id": "mem-001",
      "created_at": "2021-09-15T00:00:00Z",
      "modified_at": "2021-10-16T00:00:00Z",
      "user_id": "a1234567-89ab-cdef-0123-456789abcdef",
      "conversation_id": "a1234567-89ab-cdef-0123-456789abcdef",
      "body": "Hello World",
      "subject_line": "Hello World",
      "root_message_id": "a1234567-89ab-cdef-0123-456789abcdef",
      "url": "https://example.com/messages/mem-001",
      "remote_created_at": "2021-09-15T00:00:00Z",
      "remote_updated_at": "2021-09-16T00:00:00Z",
      "remote_was_deleted": true
    }
  ]
}

Returns a list of Message objects.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

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.

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 nullOptional

previousstring or nullOptional

resultslist of objectsOptional

/messages

Authentication

Headers

Query parameters

Response

Field support by integration

Field support by integration