Show Developer Menu

GET /conversations

Issuing a GET call to conversations will allow you to retrieve conversations for the Brand

Example Request

curl 'https://{brand}.reamaze.io/api/v1/conversations' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'

Example Response

{
  "page_size": 30,
  "page_count": 1,
  "total_count": 10,
  "conversations": [
    {
      "subject": "Knock, knock?",
      "slug": "knock-knock",
      "status": 0,
      "created_at": "2000-01-01T00:00:01.001-01:00",
      "tag_list": ["joke"],
      "message": {
        "body": "Who's there?"
      },
      "last_customer_message": {
        "body": "Insert joke here",
        "created_at": "2000-01-01T01:00:01.001-01:00",
      },
      "author": {
        "name": "bob",
        "email": "[email protected]"
      },
      "assignee": null,
      "category": {
        "name": "Support",
        "slug": "support",
        "email": "[email protected]",
        "channel": 1
      },
      "followers": [{
        "name": "bob",
        "email": "[email protected]"
      }]
    },
    ...
  ]
}

Optional Params

By default, this API end point only returns unarchived conversations.

• filter with archived, open, unassigned, or all will show only Archived, Open, Unassigned or All conversations, respectively.
• for with a value matching a known user email will return only conversations relevant to that user. For example, for a customer user, this would be conversations visible to that customer.
• for_id with a value matching a known user id (from SSO) will return only conversations relevant to that customer user.
• sort with a value of updated will return conversations in descending order of last customer update. A value of changed will return conversations in descending order of any update or status change. The default sort order is by conversation create_at.
• tag with string value (comma separated) will return conversations matching specific tags.
• category with a string value will return conversations matching a specific Channel (internally called category) matching the slug value.
• data with a hash of key/value pairs (e.g. data[key]=value) will return conversations with data matching those key/value pairs.
• page with any number will allow you to paginate through results. page_size and page_count are provided by the result.
• start_date and end_date (ISO8601 format) will allow filtering of conversations by time of latest customer message.
• origin with an integer or string value will filter conversations by their origin (where they were created). You can use either the numeric value (e.g. origin=1 for Email) or the name (e.g. origin=email). See GET /messages for the full list of origin values.

Notes

• The slug uniquely identifies a conversation.
• The category/channel value denotes the channel type. See GET /channels for the full list of channel values.
• The origin value denotes where conversation originated. Note this can be different from the channel, since conversations can be moved and both Reamaze.js and Email conversations go into Email channels. See GET /messages for the full list of origin values.
• The status value denotes the status of the conversation:
  • 0 - Open
  • 1 - Responded
  • 2 - Done
  • 3 - Spam
  • 4 - Archived
  • 5 - On Hold
  • 6 - Auto-Done
  • 7 - AI Agent Assigned
  • 8 - AI Agent Done
  • 9 - Spam (identified by AI)
• The followers array lists all users (staff and customers) who are involved in the conversation thread as either active participants or CC recipients.