AgentBots
Inbox API
Conversations API
Contact Labels
CSAT Survey Page
Account AgentBots
Agents
Canned Responses
Canned Response
Custom Attributes
Contacts
Automation Rule
Help Center
Conversations
Conversation Assignment
Conversation Labels
Inboxes
Integrations
Profile
Teams
Custom Filters
Contacts
Contact Filter
Contacts
Contact Filter
Filter contacts with custom filter options and pagination
POST
/
api
/
v1
/
accounts
/
{account_id}
/
contacts
/
filter
curl --request POST \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/contacts/filter \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{
"payload": [
{
"attribute_key": "name",
"filter_operator": "equal_to",
"values": [
"en"
],
"query_operator": "AND"
},
{
"attribute_key": "country_code",
"filter_operator": "equal_to",
"values": [
"us"
],
"query_operator": null
}
]
}'
[
{
"id": 123,
"payload": {
"contact": {
"email": "<string>",
"name": "<string>",
"phone_number": "<string>",
"thumbnail": "<string>",
"additional_attributes": {},
"custom_attributes": {
"attribute_key": "attribute_value",
"signed_up_at": "dd/mm/yyyy"
},
"contact_inboxes": [
{
"source_id": "<string>",
"inbox": {
"id": 123,
"name": "<string>",
"website_url": "<string>",
"channel_type": "<string>",
"avatar_url": "<string>",
"widget_color": "<string>",
"website_token": "<string>",
"enable_auto_assignment": true,
"web_widget_script": "<string>",
"welcome_title": "<string>",
"welcome_tagline": "<string>",
"greeting_enabled": true,
"greeting_message": "<string>"
}
}
]
}
}
}
]
Authorizations
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.
Path Parameters
The numeric ID of the account
Query Parameters
Body
application/json
Response
200
application/json
Success
array of contacts
curl --request POST \
--url https://app.chatwoot.com/api/v1/accounts/{account_id}/contacts/filter \
--header 'Content-Type: application/json' \
--header 'api_access_token: <api-key>' \
--data '{
"payload": [
{
"attribute_key": "name",
"filter_operator": "equal_to",
"values": [
"en"
],
"query_operator": "AND"
},
{
"attribute_key": "country_code",
"filter_operator": "equal_to",
"values": [
"us"
],
"query_operator": null
}
]
}'
[
{
"id": 123,
"payload": {
"contact": {
"email": "<string>",
"name": "<string>",
"phone_number": "<string>",
"thumbnail": "<string>",
"additional_attributes": {},
"custom_attributes": {
"attribute_key": "attribute_value",
"signed_up_at": "dd/mm/yyyy"
},
"contact_inboxes": [
{
"source_id": "<string>",
"inbox": {
"id": 123,
"name": "<string>",
"website_url": "<string>",
"channel_type": "<string>",
"avatar_url": "<string>",
"widget_color": "<string>",
"website_token": "<string>",
"enable_auto_assignment": true,
"web_widget_script": "<string>",
"welcome_title": "<string>",
"welcome_tagline": "<string>",
"greeting_enabled": true,
"greeting_message": "<string>"
}
}
]
}
}
}
]