List contacts linked to a conversation

GET

/api/v1/conversations/{conversation_id}/contacts

const url = 'https://api.inside.chat/api/v1/conversations/example/contacts';
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/contacts \
  --header 'Authorization: Bearer <token>'

Required scopes: conversation_read, contact_read, contact_read_pii
Data access: pii
MCP tool: conversation_contacts

Page current contact IDs linked to the selected stored conversation visitor. Unrestricted policy required; excludes erased/foreign links and profiles, with no inferred primary or remote CRM.

Authorizations

installation_token
oauth_client_credentials
conversation_read contact_read contact_read_pii

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.

limit

integer

>= 1 <= 100

cursor

Continue at the last delivered owned resource ID. Existing canonical base64 positive signed-64-bit numeric history cursors are also accepted for transcript and visitor history.

string

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

Responses

200

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

application/json

object

data

required

object

data

required

Array<object>

<= 100 items

object

required

string

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

next_cursor

required

Any of:

string
null

string

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

coverage

required

Allowed value: persisted_conversation_contact_links

conversation_id

required

string

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

Example

{
  "data": {
    "coverage": "persisted_conversation_contact_links"
  }
}

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.