Get a contact belonging to the account using ID
curl --request GET \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/contacts/{id} \
--header 'api_access_token: <api-key>'{
"payload": {
"additional_attributes": {
"city": "<string>",
"country": "<string>",
"country_code": "<string>",
"created_at_ip": "<string>"
},
"availability_status": "online",
"email": "<string>",
"id": 123,
"name": "<string>",
"phone_number": "<string>",
"blocked": true,
"identifier": "<string>",
"thumbnail": "<string>",
"custom_attributes": {},
"last_activity_at": 123,
"created_at": 123,
"contact_inboxes": [
{
"source_id": "<string>",
"inbox": {
"id": 123,
"avatar_url": "<string>",
"channel_id": 123,
"name": "<string>",
"channel_type": "<string>",
"provider": "<string>"
}
}
]
}
}This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.
The numeric ID of the account
ID of the contact
Success
Show child attributes
The object containing additional attributes related to the contact
Show child attributes
Availability status of the contact
online, offline The email address of the contact
The ID of the contact
The name of the contact
The phone number of the contact
Whether the contact is blocked
The identifier of the contact
The thumbnail of the contact
The custom attributes of the contact
Timestamp of last activity
Timestamp when contact was created
List of inboxes associated with this contact
Show child attributes
Source identifier for the contact inbox
Show child attributes
ID of the inbox
URL for the inbox avatar
ID of the channel
Name of the inbox
Type of channel
Provider of the inbox
curl --request GET \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/contacts/{id} \
--header 'api_access_token: <api-key>'{
"payload": {
"additional_attributes": {
"city": "<string>",
"country": "<string>",
"country_code": "<string>",
"created_at_ip": "<string>"
},
"availability_status": "online",
"email": "<string>",
"id": 123,
"name": "<string>",
"phone_number": "<string>",
"blocked": true,
"identifier": "<string>",
"thumbnail": "<string>",
"custom_attributes": {},
"last_activity_at": 123,
"created_at": 123,
"contact_inboxes": [
{
"source_id": "<string>",
"inbox": {
"id": 123,
"avatar_url": "<string>",
"channel_id": 123,
"name": "<string>",
"channel_type": "<string>",
"provider": "<string>"
}
}
]
}
}