/v1/saved-filtersbetaList saved filters
- Needs
- Read your data
(mcp:read) - Plan
- Any plan with API access
- Limits
- 300 a minute per key
- Undo
- Nothing to undo: this only reads.
Lists the contact (or conversation) filters your team saved in the app. Use detail=full to include each stored filter definition.
Try it
Query (5)
`contact` (default) or `conversation` filters.
Name contains this text.
`summary` (default) or `full` (adds the stored filter definition).
The `next_cursor` from the previous page. Cursors expire after 24 hours.
How many items per page (1–100).
This only reads. It uses your real data and changes nothing.
Code and response
curl -X GET 'https://mcp.wa-api.cloud/v1/saved-filters?type=contact' \ -H "Authorization: Bearer $API_KEY"
The code reads your key from $API_KEY.
Parameters
| Field | Type | What it is |
|---|---|---|
| type | string · query | contact (default) or conversation filters.one of: contact, conversation · default "contact" |
| search | string · query | Name contains this text.1–100 characters |
| detail | string · query | summary (default) or full (adds the stored filter definition).one of: summary, full · default "summary" |
| cursor | string · query | The next_cursor from the previous page. Cursors expire after 24 hours.1–2048 characters |
| limit | integer · query | How many items per page (1–100).1–100 · default 25 |
Headers
| Field | Type | What it is |
|---|---|---|
| Authorizationrequired | header | Bearer $API_KEY — your API key. |
| Api-Version | header | The API version to use, e.g. 2026-10-01. Default: the version your key is pinned to.one of: 2026-10-01 · pattern ^\d{4}-\d{2}-\d{2}$ |
Response 200
A page of saved filters.
| Field | Type | What it is |
|---|---|---|
| datarequired | array of object | |
| idrequired | string | |
| namerequired | string | |
| descriptionrequired | string or null | |
| typerequired | string or null | contact or conversation. |
| owner_staff_idrequired | string or null | |
| updated_atrequired | string or null | |
| filter | any | The stored filter definition (detail "full" only), as the panel saved it. |
| totalrequired | integer or null | -9007199254740991–9007199254740991 |
| next_cursorrequired | string or null | Pass as "cursor" to get the next page; null when there are no more results. |
Errors
Errors are application/problem+json. Branch on code.
| Status | Code | When |
|---|---|---|
| 400 | invalid_input | A field is missing or has the wrong format. |
| 401 | unauthenticated | The Authorization header is missing, the key is unknown, expired or revoked. |
| 403 | entitlement_required | The workspace's plan does not include API access ( |
| 403 | insufficient_scope | The key does not have the permission this operation needs. |
| 429 | rate_limited | The key or workspace went over its rate limit. Wait for |
| 503 | upstream_unavailable | A service behind the API is briefly unavailable. Safe to retry with backoff. |
Examples
Saved contact filters
Response 200
{
"data": [
{
"id": "7",
"name": "Dubai VIPs",
"description": "VIP tag, city Dubai",
"type": "contact",
"owner_staff_id": "501",
"updated_at": "2026-09-02T08:00:00Z"
}
],
"next_cursor": null,
"total": 1
}Operation path
The same operation is also at POST /v1/ops/crm_list_saved_filters, with every field in the JSON body.