Inbox
Shared inbox helpdesk for all your support channels. Built for your team.
Chat
Live chat with automated messaging, chatbots, and video calls for your website or web app.
Chatbots
Automate every business opportunity with pre-built and custom chatbots.
Push Campaigns
Increase re-engagement and boost sales with targeted push notification campaigns.
AI BETA
Leverage the power of AI to help you respond, create, and summarize.
FAQ
Customizable and embeddable FAQ center to help customers help themselves.
Status Page
Keep customers informed by alerting them when there’s an incident or outage.
Live
Get more sales with real time customer activity monitoring and personal messages.

Show Developer Menu

GET /conversations/{slug}

Issuing a GET call to conversations will allow you to retrieve a specific conversation

Example Request
curl 'https://{brand}.reamaze.io/api/v1/conversations/{slug}' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Optional Query Parameters
  • id_type - Specify how to interpret the ID parameter:
    • ref - Look up by reference ID (ref_id)
    • origin - Look up by origin ID (requires category and optionally channel parameters)
  • category - Category slug (required when using id_type=origin)
  • channel - Channel type (optional, used with id_type=origin)
ID Lookup Behavior

The API looks up conversations in the following order:

  1. First, by conversation slug (default)
  2. If id_type=ref, by reference ID (ref_id)
  3. If id_type=origin, by origin ID within the specified category
  4. If no id_type is specified and slug lookup fails, falls back to database ID lookup
Example with Reference ID
curl 'https://{brand}.reamaze.io/api/v1/conversations/{ref_id}?id_type=ref' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example with Origin ID
curl 'https://{brand}.reamaze.io/api/v1/conversations/{origin_id}?id_type=origin&category=support' \
  -u {login-email}:{api-token} \
  -H 'Accept: application/json'
Example Response
{
  "subject": "Knock, knock?",
  "slug": "knock-knock",
  "status": 0,
  "created_at": "2000-01-01T00:00:01.001-01:00",
  "tag_list": ["joke"],
  "message": {
    "body": "I've got a great joke for you!"
  },
  "last_staff_message": {
    "body": "Who's there?",
    "created_at": "2000-01-01T01:00:01.001-01:00",
  },
  "last_customer_message": {
    "body": "Insert joke here",
    "created_at": "2000-01-01T01:00:01.001-01:00",
  },
  "author": {
    "name": "bob",
    "email": "bob@example.com"
  },
  "assignee": null,
  "category": {
    "name": "Support",
    "slug": "support",
    "email": "support@example.com",
    "channel": 1
  },
  "data": {
    "custom_attribute": "custom data"
  },
  "followers": [{
    "name": "bob",
    "email": "bob@example.com"
  }]
}