> ## Documentation Index
> Fetch the complete documentation index at: https://docs.aseeflow.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Filters

> Queries for a list of filters using a list of parameters. The size of the result
set can be retrieved
by using the [Get Filter Count](https://docs.aseeflow.org/reference/rest/filter/get-filter-count/) method.



## OpenAPI

````yaml /reference/rest/openapi-1.0.json get /filter
openapi: 3.0.2
info:
  title: ASEE Flow Platform REST API
  description: OpenApi Spec for ASEE Flow Platform REST API.
  version: 1.0.0
  license:
    name: Apache License 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: http://{host}:{port}/{contextPath}
    description: The API server for the default process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
  - url: http://{host}:{port}/{contextPath}/engine/{engineName}
    description: The API server for a named process engine
    variables:
      host:
        default: localhost
      port:
        default: '8080'
      contextPath:
        default: engine-rest
      engineName:
        default: default
  - url: '{url}'
    description: The API server with a custom url
    variables:
      url:
        default: ''
security:
  - basicAuth: []
tags:
  - name: Authorization
  - name: Batch
  - name: Condition
  - name: Decision Definition
  - name: Decision Requirements Definition
  - name: Deployment
  - name: Engine
  - name: Event Subscription
  - name: Execution
  - name: External Task
  - name: Filter
  - name: Group
  - name: Historic Activity Instance
  - name: Historic Batch
  - name: Historic Decision Definition
  - name: Historic Decision Instance
  - name: Historic Decision Requirements Definition
  - name: Historic Detail
  - name: Historic External Task Log
  - name: Historic Identity Link Log
  - name: Historic Incident
  - name: Historic Job Log
  - name: Historic Process Definition
  - name: Historic Process Instance
  - name: Historic Task Instance
  - name: Historic User Operation Log
  - name: Historic Variable Instance
  - name: History Cleanup
  - name: Identity
  - name: Incident
  - name: Job
  - name: Job Definition
  - name: Message
  - name: Metrics
  - name: Migration
  - name: Modification
  - name: Process Definition
  - name: Process Instance
  - name: Signal
  - name: Schema Log
  - name: Task
  - name: Task Attachment
  - name: Task Comment
  - name: Task Identity Link
  - name: Task Local Variable
  - name: Task Variable
  - name: Telemetry
  - name: Tenant
  - name: User
  - name: Variable Instance
  - name: Version
externalDocs:
  description: Find out more about ASEE Flow Rest API
  url: https://docs.aseeflow.org/reference/rest/overview/
paths:
  /filter:
    get:
      tags:
        - Filter
      summary: Get Filters
      description: >-
        Queries for a list of filters using a list of parameters. The size of
        the result

        set can be retrieved

        by using the [Get Filter
        Count](https://docs.aseeflow.org/reference/rest/filter/get-filter-count/)
        method.
      operationId: getFilterList
      parameters:
        - name: filterId
          in: query
          schema:
            type: string
          description: Filter by the id of the filter.
        - name: resourceType
          in: query
          schema:
            type: string
          description: Filter by the resource type of the filter, e.g., `Task`.
        - name: name
          in: query
          schema:
            type: string
          description: Filter by the name of the filter.
        - name: nameLike
          in: query
          schema:
            type: string
          description: Filter by the name that the parameter is a substring of.
        - name: owner
          in: query
          schema:
            type: string
          description: Filter by the user id of the owner of the filter.
        - name: itemCount
          in: query
          schema:
            type: boolean
          description: >-
            If set to `true`, each filter result will contain an `itemCount`
            property

            with the number of items matched by the filter itself.
        - name: sortBy
          in: query
          schema:
            enum:
              - filterId
              - resourceType
              - name
              - owner
            type: string
          description: |-
            Sort the results lexicographically by a given criterion.
            Must be used in conjunction with the sortOrder parameter.
        - name: sortOrder
          in: query
          schema:
            enum:
              - asc
              - desc
            type: string
          description: >-
            Sort the results in a given order. Values may be asc for ascending
            order or desc for descending order.

            Must be used in conjunction with the sortBy parameter.
        - name: firstResult
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the index of the first result to
            return.
        - name: maxResults
          in: query
          schema:
            type: integer
          description: >-
            Pagination of results. Specifies the maximum number of results to
            return.

            Will return less results if there are no more results left.
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FilterDto'
              examples:
                example-1:
                  summary: request
                  description: GET `/filter?resourceType=Task`
                  value:
                    - id: aFilter
                      resourceType: Task
                      name: My Filter
                      owner: jonny1
                      query:
                        assignee: jonny1
                      properties:
                        color: '#58FA58'
                        description: Filters assigned to me
                    - id: anotherFilter
                      resourceType: Task
                      name: Accountants Filter
                      owner: demo
                      query:
                        candidateGroup: accountant
                      properties:
                        description: Filters assigned to me
                        priority: 10
                example-2:
                  summary: request with itemCount
                  description: GET `/filter?resourceType=Task&itemCount=true`
                  value:
                    - id: aFilter
                      resourceType: Task
                      name: My Filter
                      owner: jonny1
                      query:
                        assignee: jonny1
                      properties:
                        color: '#58FA58'
                        description: Filters assigned to me
                      itemCount: 13
                    - id: anotherFilter
                      resourceType: Task
                      name: Accountants Filter
                      owner: demo
                      query:
                        candidateGroup: accountant
                      properties:
                        description: Filters assigned to me
                        priority: 10
                      itemCount: 42
          description: Request successful.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExceptionDto'
          description: >

            Returned if some of the query parameters are invalid, for example if

            a `sortOrder`

            parameter is supplied, but no `sortBy` is specified. See the

            [Introduction](https://docs.aseeflow.org/reference/rest/overview/#error-handling)

            for the error response format.
components:
  schemas:
    FilterDto:
      type: object
      properties:
        id:
          type: string
          nullable: true
          description: The id of the filter.
        resourceType:
          type: string
          nullable: true
          description: The resource type of the filter.
        name:
          type: string
          nullable: true
          description: The name of the filter.
        owner:
          type: string
          nullable: true
          description: The user id of the owner of the filter.
        query:
          type: object
          description: The query of the filter as a JSON object.
        properties:
          type: object
          description: The properties of a filter as a JSON object.
        itemCount:
          type: integer
          format: int64
          nullable: true
          description: |-

            The number of items matched by the filter itself. Note: Only exists
            if the query parameter
            `itemCount` was set to `true`
    ExceptionDto:
      title: ExceptionDto
      type: object
      properties:
        type:
          type: string
          nullable: true
          description: An exception class indicating the occurred error.
        message:
          type: string
          nullable: true
          description: A detailed message of the error.
        code:
          type: number
          description: >-
            The code allows your client application to identify the error in an
            automated fashion.

            You can look up the meaning of all built-in codes and learn how to
            add custom codes

            in the [User
            Guide](https://docs.aseeflow.org/user-guide/process-engine/error-handling/#exception-codes).
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````