Evaluates a filter by applying it to the specified target user type and returning the filtered results. Supports standard paging, ordering, and additional query constraints from query parameters.

GET

https://api.awork.com/api/v1/me/filters/:filterId/:entityType

Retrieves and evaluates a saved filter to return matching entities.

Any authenticated user.

Retrieves and evaluates a saved filter to return matching entities. <Check title="Required Permissions" icon="key">Any authenticated user.</Check>

AuthorizationBearer

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

filterIdstringRequiredformat: "uuid"

The identifier of the filter to evaluate.

entityTypestringRequired

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

itemslist of any or nullOptional

totalCountintegerOptional

pageNumberintegerOptional

pageSizeintegerOptional

sortPropertyNamestring or nullOptional

sortOrderenumOptional

nextCursorstring or nullOptional

itemCountintegerOptionalRead-only

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

1	{
2	"items": [
3	{
4	"createdAt": "2024-05-10T09:15:00Z",
5	"id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a1d9e",
6	"name": "Marketing Campaign Q2",
7	"ownerId": "d2f4e6a7-8b9c-4d3e-9f1a-7b6c5d4e3f2a",
8	"status": "active"
9	}
10	],
11	"totalCount": 1,
12	"pageNumber": 1,
13	"pageSize": 1,
14	"sortPropertyName": "createdAt",
15	"sortOrder": 0,
16	"nextCursor": null,
17	"itemCount": 1
18	}

$	curl https://api.awork.com/api/v1/me/filters/filterId/entityType \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json"