Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Contacts::Filter

Get a Contact Filter

Fetches a previously saved contact filter by id. This route is shallow — the workspace is resolved from the filter itself, so no workspace_id is required in the path. Use the id (or public_id) returned by POST /api/v2/workspaces/{workspace_id}/contacts/filters with save: true.

Returns the same resource shape as the generate endpoint, with the identity fields populated. The stable_id is re-derived from the saved filter, so it can be passed straight to GET /api/v2/workspaces/{workspace_id}/contacts?stable_id=….

get/contacts/filters/{id}

Path parameters

idstring required

The saved filter's id or public_id.

Response

OK

idinteger required

Saved filter ID.

public_idstring required

Obfuscated saved filter ID.

workspace_idinteger required

Workspace the filter belongs to.

namestring nullable required

Name of the saved filter, or null when it has no name.

stable_idstring required

URL-encoded Refine stable_id token in the standard gzip+base64 full-state format — interoperable with the server-rendered filter UI. Pass as ?stable_id=… to the contacts index (GET /api/v2/workspaces/{workspace_id}/contacts) to apply this filter to the results.

Example response

{
  "filter": {
    "criteria": [
      {
        "attribute": "tags.id",
        "clause": "in"
      }
    ]
  }
}