filters

Returns the current user's filters.

Changed on

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>

get/filters

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/filters
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the filter.

isExternalboolean

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

entityTypestring nullable

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

userIdstring uuid

The id of the user this filter was created for.

filterQuerystring nullable

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

workspaceAccessLevelstring nullable

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

Changes

  • 81151fac7e79Revision changes
    • info

      removed subschema #1 subschema #2 from the //////// response property oneOf list for the response status

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API