Evaluates a filter definition against the specified user type and returns the filtered results without saving the filter. This endpoint is designed for quick filters where the frontend builds a FilterDefinition dynamically and needs to evaluate it immediately without persisting it to the database. Supports standard paging, ordering, and additional query constraints from query parameters.

POST

https://api.awork.com/api/v1/filters/:entityType/evaluate

Evaluates an ad-hoc filter without persisting it. Useful for testing filters before saving or for temporary filtering needs.

Required Permissions

Any authenticated user.

Evaluates an ad-hoc filter without persisting it. Useful for testing filters before saving or for temporary filtering needs. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

entityTypestringRequired

The entity type name (tasks, projects, companies, users).

Request

The filter application form containing the FilterDefinition to evaluate.

filterDefinitionobjectRequired

The structured filter representation of a filter query.

Response

itemslist of any or nullOptional

totalCountintegerOptional

pageNumberintegerOptional

pageSizeintegerOptional

sortPropertyNamestring or nullOptional

sortOrderenumOptional

nextCursorstring or nullOptional

itemCountintegerOptionalRead-only

Errors

400

Bad Request Error

404

Not Found Error

$	curl -X POST https://api.awork.com/api/v1/filters/entityType/evaluate \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"filterDefinition": {}
>	}'

1	{
2	"items": [
3	null
4	],
5	"totalCount": 1,
6	"pageNumber": 1,
7	"pageSize": 1,
8	"sortPropertyName": "createdAt",
9	"sortOrder": 0,
10	"nextCursor": "eyJjdXJzb3IiOiIxMjM0NSJ9",
11	"itemCount": 1
12	}