Skip to main content
GET
/
api
/
v1
/
accounts
/
{account_id}
/
custom_filters
List all custom filters
curl --request GET \
  --url https://app.chatwoot.com/api/v1/accounts/{account_id}/custom_filters \
  --header 'api_access_token: <api-key>'
[
  {
    "id": 123,
    "name": "<string>",
    "type": "conversation",
    "query": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
api_access_token
string
header
required

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

​
account_id
integer
required

The numeric ID of the account

Query Parameters

​
filter_type
enum<string>

The type of custom filter

Available options:
conversation,
contact,
report

Response

Success

​
id
number

The ID of the custom filter

​
name
string

The name of the custom filter

​
type
enum<string>

The description about the custom filter

Available options:
conversation,
contact,
report
​
query
object

A query that needs to be saved as a custom filter

​
created_at
string<date-time>

The time at which the custom filter was created

​
updated_at
string<date-time>

The time at which the custom filter was updated