Getting Started
Embed Methods
Website Builders
E-commerce
API Reference
- Introduction
- Pagination and Filtering
- GETGet Org by Domain Hostname
- GETGet Chat
- DELDelete Chat
- GETGet Chat Messages
- POSTCreate Chat Message
- GETGet Chat Message
- DELDelete Chat Message
- POSTCreate Chat Note
- GETGet Chat Files
- GETGet conversation summaries
- DELClear conversation summaries
- DELDelete a conversation summary
- GETGet Org Chats
- GETGet Domains
- POSTCreate Domain
- GETGet a Domain
- DELDelete Domain
- POSTGet Domain Status
- POSTVerify Domain
- GETGet Vector Index
- GETGet Contents
- POSTCreate Content
- GETGet Content
- DELDelete Content
- PATCHUpdate Content
- PATCHPatch orgs knowledgecontents url
- POSTCreate Child Content
- POSTReindex Content
- GETGet Content Chunks
- GETGet Content Chunk
- GETGet Assistants
- POSTCreate Assistant
- GETGet Assistant
- DELDelete Assistant
- PATCHUpdate Assistant
- POSTRotate Assistant Secret Key
- GETGet Assistant Integrations
- POSTCreate Assistant Integration
- GETGet Assistant Integration
- DELDelete Assistant Integration
- PATCHUpdate Assistant Integration
- GETGet Assistant Actions
- POSTCreate Assistant Action
- GETGet Assistant Action
- DELDelete Assistant Action
- PATCHUpdate Assistant Action
- GETSearch Available Contents
- GETGet Contents
- POSTLink Knowledge Content to Assistant
- DELUnlink Knowledge Content from Assistant
- GETGet Org Variables
- POSTCreate Org Variable
- PATCHUpdate Org Variables
- DELDelete Org Variable
- PATCHRename Org Variable
- GETList Files
- POSTCreate File
- GETGet File
- DELDelete File
- GETGet Contacts
- POSTMerge Contacts
- GETGet a Contact
- DELDelete a contact
- PATCHUpdate a Contact
- DELDelete a contact channel
- PATCHUpdate a contact channel (only for custom channels)
- GETGet Contact Files
- GETList contact notes
- POSTCreate a contact note
- GETGet a contact note
- DELDelete a contact note
- PATCHUpdate a contact note
- GETGet contact memories
- DELClear all contact memories
- DELDelete a specific contact memory
- GET
Get a Contact
Get a specific contact by its ID.
{
"id": "<string>",
"name": "<string>",
"blocked": true,
"channels": [
{
"id": "<string>",
"channel_type": "internal",
"channel_id": "<string>",
"channel_name": "<string>",
"channel_display_name": "<string>",
"channel_avatar": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"platform_data": {},
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}Response
Schema for the contact
Show child attributes
Show child attributes
ID of the connection integration
internal, custom, whatsapp_bot, instagram_dm, slack_bot, telegram_bot, gmail, google_calendar The unique identifier for the contact channel, e.g Phone Number or User ID
The display name for the contact channel, e.g Username or Email
The display name for the contact channel, e.g Full Name
The avatar for the contact channel, e.g X Avatar URL
The country code associated with the contact channel, e.g US for United States
The user agent associated with the contact channel
The IP address associated with the contact channel
The language code associated with the contact channel, e.g en for English
Schema for the platform-specific data of a contact channel
A link to the contact channel, e.g a link to the social media profile
Was this page helpful?
{
"id": "<string>",
"name": "<string>",
"blocked": true,
"channels": [
{
"id": "<string>",
"channel_type": "internal",
"channel_id": "<string>",
"channel_name": "<string>",
"channel_display_name": "<string>",
"channel_avatar": "<string>",
"country": "<string>",
"agent": "<string>",
"ip": "<string>",
"language": "<string>",
"platform_data": {},
"created_at": "2023-12-25",
"updated_at": "2023-12-25",
"link": "<string>"
}
],
"created_at": "2023-12-25",
"updated_at": "2023-12-25"
}