Get a contact

GET

/api/v1/contacts/{contact_id}

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

Required scopes: contact_read
Data access: –
MCP tool: contact_get

Read an owned contact ID and blocked state. Personal fields need contact_read_pii and PII access. Unrestricted policy required; excludes reachability and remote CRM.

Authorizations

installation_token
oauth_client_credentials
contact_read

Parameters

Path Parameters

contact_id

required

string

/^ctc_[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

contact

required

One of:

object
object

object

required

string

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

blocked

required

boolean

access

required

object

pii

required

Example

{
  "data": {
    "contact": {
      "access": {
        "pii": false
      }
    }
  }
}

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.