Get a contact - Chatwoot Developer Docs

GET

public

api

inboxes

{inbox_identifier}

contacts

{contact_identifier}

Get a contact

curl --request GET \
  --url https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

{
  "id": 123,
  "source_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "pubsub_token": "<string>"
}

inbox_identifier

string

required

The identifier obtained from API inbox channel

contact_identifier

string

required

The source id of contact obtained on contact create

Success

integer

Id of the contact

source_id

string

The session identifier of the contact

name

string | null

Name of the contact when available

string | null

Email of the contact

phone_number

string | null

Phone number of the contact

pubsub_token

string

The token to be used to connect to chatwoot websocket

Get a contact

curl --request GET \
  --url https://app.chatwoot.com/public/api/v1/inboxes/{inbox_identifier}/contacts/{contact_identifier}

{
  "id": 123,
  "source_id": "<string>",
  "name": "<string>",
  "email": "<string>",
  "phone_number": "<string>",
  "pubsub_token": "<string>"
}