Returns the current user's filters.

GET

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

GET

/api/v1/filters

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

1 [
2   {
3     "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4     "createdOn": "2023-11-10T09:45:30.000Z",
5     "createdBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
6     "updatedOn": "2024-04-20T16:22:10.000Z",
7     "updatedBy": "a3bb189e-8bf9-3888-9912-ace4e6543002",
8     "name": "Open Tasks Filter",
9     "filterDefinition": {
10       "conditionGroups": [
11         {
12           "conditions": [
13             {
14               "field": "status",
15               "type": "Comparison",
16               "operator": "Equal",
17               "values": [
18                 {
19                   "constantValue": "Open",
20                   "filterValueKind": "Constant",
21                   "computedValueKind": null,
22                   "daysOffset": null
23                 }
24               ],
25               "customFieldInformation": {
26                 "customFieldDefinitionId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
27                 "customFieldValueType": "Text"
28               }
29             }
30           ],
31           "connector": "And"
32         }
33       ],
34       "rootConnector": "And",
35       "entityType": "tasks"
36     },
37     "isExternal": false,
38     "entityType": "tasks",
39     "userId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
40     "filterQuery": "status eq 'Open'",
41     "workspaceAccessLevel": "read",
42     "contributors": [
43       {
44         "id": "b1a7f3d2-4c3e-4f9a-9f3a-1a2b3c4d5e6f",
45         "userId": "a3bb189e-8bf9-3888-9912-ace4e6543002",
46         "accessLevel": "manage",
47         "firstName": "Lisa",
48         "lastName": "Smith",
49         "hasImage": true,
50         "isDeactivated": false
51       }
52     ],
53     "teams": [
54       {
55         "id": "c2d3e4f5-6789-4abc-def0-123456789abc",
56         "teamId": "d4e5f6a7-b8c9-4def-0123-456789abcdef",
57         "accessLevel": "read",
58         "name": "Designers",
59         "icon": "paintbrush",
60         "color": "purple"
61       }
62     ]
63   }
64 ]

Returns the union of filters owned by the requesting user and filters explicitly shared with the requesting user. Use the specialized created-by-me and shared-with-me endpoints when only one category is needed.

Required Permissions

Any authenticated user.

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

pageSizeintegerOptionalDefaults to 10

Number of items per page

orderbystringOptional

The properties to order by

filterbystringOptional

The filter expression to filter by

Response

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

namestring or nullOptional

The name of the filter.

filterDefinitionobjectOptional

The structured filter representation of a filter query.

isExternalbooleanOptional

Whether this filter is coming from an external workspace (awork Connect).

entityTypestring or nullOptional

The entity type this filter targets. Can be 'projects', 'tasks', 'companies', 'users'.

userIdstringOptionalformat: "uuid"

The id of the user this filter was created for.

filterQuerystring or nullOptional

The OData- query string that will be applied for querying this filter’s underlying data type.

workspaceAccessLevelstring or nullOptional

Determines the level of access to this filter granted to all workspace users. Can be either not set (no access), read, or manage.

contributorslist of objects or nullOptional

The users explicitly connected to this filter.

teamslist of objects or nullOptional

The teams explicitly connected to this filter.

Errors

404

Not Found Error