Search entities

Performs a filtered search over Entities using a POST request. This endpoint supports the same filtering capabilities as GET /v2/entities, but allows a larger and more complex payload. It's useful when filtering by a long list of foreign key IDs or when URL length limits become a problem.

Filter availability

Not all filters apply to all entity types. For example, status filtering is only available for types that have a status field (e.g. feature, initiative), and parent filtering only works for types that have a parent relationship.

Use GET /v2/entities/configurations/{type} to check which filters are supported for a specific type. The filters array in the configuration response lists all available filter parameters, their exact query parameter names, and value schemas.

Filtering by owner[email] requires the members:pii:read scope.

Limitations

  • Only the AND operator is supported when applying multiple filters. OR, NOT, or nested conditions are not supported.
  • You can search only within one entity type at a time.
Query Params
string

Cursor for pagination. Use the value from links.next to fetch the next page.

Body Params
data
object

Request body for searching entities. Supports two formats:

New format (recommended): Uses a structured filter object with nested field groups. Legacy format (deprecated): Uses flat properties directly under data.

Both formats are accepted. The legacy format will continue to work but is deprecated in favour of the new structured format. Format is detected by the presence of the filter key.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json