---
title: "Returns the current user's filters."
method: GET
path: "/filters"
tags: ["filters"]
---

# Returns the current user's filters.

`GET /filters`

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.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

## Query parameters

- `page` integer
- `pageSize` integer
- `orderby` string
- `filterby` string

## Headers

- `Authorization` string, required

## Response `200`

OK

- Filter[]
  - `id` string, uuid — The id of the entity.
  - `createdOn` string, date-time — The date this entity was created.
  - `createdBy` string, uuid — The id of the user who created this entity.
  - `updatedOn` string, date-time — The date this entity was last modified.
  - `updatedBy` string, uuid — The id of the user who last modified this entity.
  - `name` string, nullable — The name of the filter.
  - `filterDefinition` FilterDefinition — The structured filter representation of a filter query.
    - `conditionGroups` ConditionGroup[], nullable — The condition groups within the filter definition.
      - `conditions` Condition[], nullable — A list of conditions within this condition group.
        - `field` string, nullable — The field to filter on. For collection fields, use the full path including the inner field (e.g., "tags/id", "assignees/id").
        - `type` 'Comparison' | 'Collection' | 'CustomField' — The type of condition.
        - `operator` 'Equal' | 'NotEqual' | 'GreaterThan' | 'GreaterThanOrEqual' | 'LessThan' | 'LessThanOrEqual' | 'Contains' | 'DoesNotContain' | 'Between' | 'IsSet' | 'IsNotSet' | 'WithinThisWeek' | 'WithinThisMonth' — The supported operators for a filter condition. These operators map directly to UI filter options.
        - `values` FilterValue[], nullable — The values for this condition. Usage depends on operator: - Single-value operators (Equal, NotEqual, etc.): Use Values[0] - Multi-value operators (In): Use all Values - Range operators (Between): Use Values[0] as start, Values[1] as end - No-value operators (IsSet, IsNotSet, WithinThisWeek, WithinThisMonth): Values is null or empty
          - `constantValue` unknown
          - `filterValueKind` 'Constant' | 'Computed' — The kind of the value in the context of a Awork.Core.Models.Filters.FilterDefinition.Condition.Value.FilterValue, either 'Constant' or 'Computed'.
          - `computedValueKind` 'Me' | 'Now' | 'Today' | 'EndOfWeek' | 'EndOfMonth' | 'StartOfWeek' | 'StartOfMonth' — The kind of computed value in the context of a Awork.Core.Models.Filters.FilterDefinition.Condition.Value.FilterValue. These represent actual VALUES that can be used with operators (e.g., "dueOn eq today", "dueOn ge sow"). Note: WithinThisWeek and WithinThisMonth are operators (Operator enum), not values.
          - `daysOffset` integer, nullable — The offset for the computed value, if the value is computed and is of kind 'Today'. Only need for Today computations for now.
        - `customFieldInformation` CustomFieldInformation
          - `customFieldDefinitionId` string, uuid — The custom field definition id.
          - `customFieldValueType` 'UserId' | 'Number' | 'SelectionOptionId' | 'Text' | 'Date' | 'Boolean' | 'Client' — The supported types of custom field values.
      - `connector` 'And' | 'Or' — The connector connecting condition groups or conditions within a Awork.Core.Models.Filters.FilterDefinition.FilterDefinition.
    - `rootConnector` 'And' | 'Or' — The connector connecting condition groups or conditions within a Awork.Core.Models.Filters.FilterDefinition.FilterDefinition.
    - `entityType` string, nullable — The entity type to filter on (e.g. "tasks", "projects", "companies", "users").
  - `isExternal` boolean — Whether this filter is coming from an external workspace (awork Connect).
  - `entityType` string, nullable — The entity type this filter targets. Can be 'projects', 'tasks', 'companies', 'users'.
  - `userId` string, uuid — The id of the user this filter was created for.
  - `filterQuery` string, nullable — The OData- query string that will be applied for querying this filter's underlying data type.
  - `workspaceAccessLevel` string, nullable — Determines the level of access to this filter granted to all workspace users. Can be either not set (no access), `read`, or `manage`.
  - `contributors` ContributorModel[], nullable — The users explicitly connected to this filter.
    - `id` string, uuid — The id of the contributor.
    - `userId` string, uuid — The id of the user this contributor references.
    - `accessLevel` string, nullable — Determines the level of access granted to this contributor with respect to the specific entity. Can be either set to `read` or `manage`.
    - `firstName` string, nullable — The first name of the user.
    - `lastName` string, nullable — The last name of the user.
    - `hasImage` boolean, nullable — Whether the user has an image.
    - `isDeactivated` boolean — Whether the user is deactivated.
  - `teams` EntityToTeamModel[], nullable — The teams explicitly connected to this filter.
    - `id` string, uuid — The id of the entity to team.
    - `teamId` string, uuid — The id of the team this entity to team references.
    - `accessLevel` string, nullable — Determines the level of access granted to this entity to team with respect to the specific entity. Can be either set to `read` or `manage`.
    - `name` string, nullable — The name of the team.
    - `icon` string, nullable — The icon which is assigned to the team.
    - `color` string, nullable — The color of the team.

## Other responses

- `404` — Not Found

---

[API](https://skmtc.net/awork-io/apis/api-v1-reference.md) · [All operations](https://skmtc.net/awork-io/apis/api-v1-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/awork-io/api-v1-reference/versions/f784a53f60df/schema)
