Get a conversation

GET

/api/v1/conversations/{conversation_id}

const url = 'https://api.inside.chat/api/v1/conversations/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.inside.chat/api/v1/conversations/example \
  --header 'Authorization: Bearer <token>'

Required scopes: conversation_read
Data access: –
MCP tool: conversation

Read an authorized conversation with its permitted data projection.

Authorizations

installation_token
oauth_client_credentials
conversation_read

Parameters

Path Parameters

conversation_id

required

string

/^con_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

Query Parameters

website_id

string

/^web_[0-9]{1,20}_[1-9][0-9]{0,18}$/

Optional; if present must match the resource owner.

Responses

200

Authorized result. Projection depends on current scopes and data policy.

application/json

object

data

required

object

conversation

required

object

required

string

<= 100 characters /^con_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

visitor_id

required

string

<= 100 characters /^vis_[0-9]{1,20}_[1-9][0-9]{0,18}_[1-9][0-9]{0,18}$/

operator_id

required

Any of:

string
null

string

<= 100 characters /^opr_[0-9]{1,20}_[1-9][0-9]{0,9}$/

status

required

string

Allowed values: unassigned open pending closed resolved onhold unknown

platform

required

string

Allowed values: chat email voice sms messenger salesforce zendesk facebook line whatsapp twitter wechat apple_messages qr_code google_business_messages instagram kakao_talk viber unknown

started_at

required

string format: date-time

<= 40 characters

active

required

boolean

subject

required

Any of:

string
null

string

<= 4000 characters

coverage

required

Allowed value: persisted_conversations

Example

{
  "data": {
    "conversation": {
      "status": "unassigned",
      "platform": "chat"
    },
    "coverage": "persisted_conversations"
  }
}

400

Invalid, duplicate or unsupported request parameters.

401

Missing, expired or revoked installation credential.

404

Resource not found or not permitted by current authority.

422

The requested capability is not available for application installations.

429

Per-app quota exceeded.

Headers

Retry-After

integer

>= 1

503

Enrollment, native service or required authority is unavailable.