OpenProject

OpenProject Query Filter Instance Schema API

A QueryFilterInstanceSchema is a Schema specifically for describing QueryFilterInstances. Because the behaviour of FilterInstances, with regards to the `values` property, differs from one another depending on the chosen Filter, the QueryFilterInstanceSchema explicitly lists the dependencies in its `_dependencies` property. As the property causing the difference is the selected Filter, that property is linked. Apart from that, a QueryFilterInstanceSchema has the same structure a Schema does. ## Linked Properties | Link | Description | Type | Constraints | Supported operations | | :-------------------: | ---------------------------------------- | ------------- | -------- | -------------------- | | self | This QueryFilterInstanceSchema (same as for schema) | QueryFilterInstanceSchema | not null | READ | | filter | The filter for which this schema is specific | Filter | not null | READ | ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :--------------: | ------------------------------------------------------ | ------------ | -------------------------------- | -------------------- | | name | Describes the name attribute | Field schema | not null | READ | | filter | QuerySortBy name | Field schema | not null | READ |

GitHub OpenAPI

Operations 4

GET /api/v3/projects/{id}/queries/filter_instance_schemas List Query Filter Instance Schemas for Project #
GET /api/v3/queries/filter_instance_schemas List Query Filter Instance Schemas #
GET /api/v3/queries/filter_instance_schemas/{id} View Query Filter Instance Schema #
GET /api/v3/workspace/{id}/queries/filter_instance_schemas List Query Filter Instance Schemas for Workspace #

Documentation

📖
Documentation
https://www.openproject.org/docs/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-query-filter-instance-schema-api-openapi.yml

Other Resources

🔗
Introduction
https://www.openproject.org/docs/api/introduction/
🔗
Endpoints
https://www.openproject.org/docs/api/endpoints/
🔗
GitHub
https://github.com/opf/openproject

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openproject:openproject-query-filter-instance-schema-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openproject-query-filter-instance-schema-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Query Filter Instance Schema API
  version: '3'
servers:
- url: https://qa.openproject-edge.com
  description: Edge QA instance
- url: https://qa.openproject-stage.com
  description: Staging instance
- url: https://community.openproject.org
  description: Community instance
security:
- BasicAuth: []
tags:
- description: A QueryFilterInstanceSchema is a Schema specifically for describing QueryFilterInstances.
  name: Query Filter Instance Schema
paths:
  /api/v3/projects/{id}/queries/filter_instance_schemas:
    get:
      parameters:
      - description: Project id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      elements:
                      - _dependencies:
                        - _type: SchemaDependency
                          dependencies:
                            /api/v3/queries/operators/!:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                            /api/v3/queries/operators/!*: {}
                            /api/v3/queries/operators/*: {}
                            /api/v3/queries/operators/=:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                          'on': operator
                        _links:
                          filter:
                            href: /api/v3/queries/filters/assignee
                            title: Assignee
                          self:
                            href: /api/v3/queries/filter_instance_schemas/assignee
                        _type: QueryFilterInstanceSchema
                        filter:
                          _links: {}
                          hasDefault: false
                          name: Filter
                          required: true
                          type: QueryFilter
                          writable: true
                        name:
                          hasDefault: true
                          name: Name
                          required: true
                          type: String
                          writable: false
                      - _dependencies:
                        - _type: SchemaDependency
                          dependencies:
                            /api/v3/queries/operators/!:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                            /api/v3/queries/operators/=:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                          'on': operator
                        _links:
                          filter:
                            href: /api/v3/queries/filters/author
                            title: Author
                          self:
                            href: /api/v3/queries/filter_instance_schemas/author
                        _type: QueryFilterInstanceSchema
                        filter:
                          _links: {}
                          hasDefault: false
                          name: Filter
                          required: true
                          type: QueryFilter
                          writable: true
                        name:
                          hasDefault: true
                          name: Name
                          required: true
                          type: String
                          writable: false
                    _links:
                      self:
                        href: /api/v3/projects/42/queries/filter_instance_schemas
                    _type: Collection
                    count: 2
                    total: 2
              schema:
                $ref: '#/components/schemas/Query_Filter_Instance_Schemas_For_WorkspaceModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:Unauthenticated
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see it.


            **Required permission:** view work package in any project'
          headers: {}
      tags:
      - Query Filter Instance Schema
      description: 'Returns the list of QueryFilterInstanceSchemas defined for a query

        of the specified project.


        This endpoint is deprecated and replaced by `/api/v3/workspaces/{id}/queries/filter_instance_schemas`'
      operationId: List_Query_Filter_Instance_Schemas_for_Project
      summary: List Query Filter Instance Schemas for Project
  /api/v3/queries/filter_instance_schemas:
    get:
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      elements:
                      - _dependencies:
                        - _type: SchemaDependency
                          dependencies:
                            /api/v3/queries/operators/!:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                            /api/v3/queries/operators/!*: {}
                            /api/v3/queries/operators/*: {}
                            /api/v3/queries/operators/=:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                          'on': operator
                        _links:
                          filter:
                            href: /api/v3/queries/filters/assignee
                            title: Assignee
                          self:
                            href: /api/v3/queries/filter_instance_schemas/assignee
                        _type: QueryFilterInstanceSchema
                        filter:
                          _links: {}
                          hasDefault: false
                          name: Filter
                          required: true
                          type: QueryFilter
                          writable: true
                        name:
                          hasDefault: true
                          name: Name
                          required: true
                          type: String
                          writable: false
                      - _dependencies:
                        - _type: SchemaDependency
                          dependencies:
                            /api/v3/queries/operators/!:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                            /api/v3/queries/operators/=:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                          'on': operator
                        _links:
                          filter:
                            href: /api/v3/queries/filters/author
                            title: Author
                          self:
                            href: /api/v3/queries/filter_instance_schemas/author
                        _type: QueryFilterInstanceSchema
                        filter:
                          _links: {}
                          hasDefault: false
                          name: Filter
                          required: true
                          type: QueryFilter
                          writable: true
                        name:
                          hasDefault: true
                          name: Name
                          required: true
                          type: String
                          writable: false
                    _links:
                      self:
                        href: /api/v3/queries/filter_instance_schemas
                    _type: Collection
                    count: 2
                    total: 2
              schema:
                $ref: '#/components/schemas/Query_Filter_Instance_SchemasModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:Unauthenticated
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see it.


            **Required permission:** view work package in any project'
          headers: {}
      tags:
      - Query Filter Instance Schema
      description: Returns the list of QueryFilterInstanceSchemas defined for a global query. That is a query not assigned to a project.
      operationId: List_Query_Filter_Instance_Schemas
      summary: List Query Filter Instance Schemas
  /api/v3/queries/filter_instance_schemas/{id}:
    get:
      parameters:
      - description: QueryFilterInstanceSchema identifier. The identifier is the filter identifier.
        example: author
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _dependencies:
                    - _type: SchemaDependency
                      dependencies:
                        /api/v3/queries/operators/!:
                          values:
                            _links: {}
                            hasDefault: false
                            name: Values
                            required: true
                            type: '[]User'
                            writable: true
                        /api/v3/queries/operators/=:
                          values:
                            _links: {}
                            hasDefault: false
                            name: Values
                            required: true
                            type: '[]User'
                            writable: true
                      'on': operator
                    _links:
                      filter:
                        href: /api/v3/queries/filters/author
                        title: Author
                      self:
                        href: /api/v3/queries/filter_instance_schemas/author
                    _type: QueryFilterInstanceSchema
                    filter:
                      _links: {}
                      hasDefault: false
                      name: Filter
                      required: true
                      type: QueryFilter
                      writable: true
                    name:
                      hasDefault: true
                      name: Name
                      required: true
                      type: String
                      writable: false
              schema:
                $ref: '#/components/schemas/Query_Filter_Instance_SchemaModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:Unauthenticated
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see it.


            **Required permission:** view work package in any project'
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The specified query does not exist.
          description: Returned if the QueryFilterInstanceSchema does not exist.
          headers: {}
      tags:
      - Query Filter Instance Schema
      description: Retrieve an individual QueryFilterInstanceSchema as identified by the id parameter.
      operationId: View_Query_Filter_Instance_Schema
      summary: View Query Filter Instance Schema
  /api/v3/workspace/{id}/queries/filter_instance_schemas:
    get:
      parameters:
      - description: Workspace id
        example: 1
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _embedded:
                      elements:
                      - _dependencies:
                        - _type: SchemaDependency
                          dependencies:
                            /api/v3/queries/operators/!:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                            /api/v3/queries/operators/!*: {}
                            /api/v3/queries/operators/*: {}
                            /api/v3/queries/operators/=:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                          'on': operator
                        _links:
                          filter:
                            href: /api/v3/queries/filters/assignee
                            title: Assignee
                          self:
                            href: /api/v3/queries/filter_instance_schemas/assignee
                        _type: QueryFilterInstanceSchema
                        filter:
                          _links: {}
                          hasDefault: false
                          name: Filter
                          required: true
                          type: QueryFilter
                          writable: true
                        name:
                          hasDefault: true
                          name: Name
                          required: true
                          type: String
                          writable: false
                      - _dependencies:
                        - _type: SchemaDependency
                          dependencies:
                            /api/v3/queries/operators/!:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                            /api/v3/queries/operators/=:
                              values:
                                _links: {}
                                hasDefault: false
                                name: Values
                                required: true
                                type: '[]User'
                                writable: true
                          'on': operator
                        _links:
                          filter:
                            href: /api/v3/queries/filters/author
                            title: Author
                          self:
                            href: /api/v3/queries/filter_instance_schemas/author
                        _type: QueryFilterInstanceSchema
                        filter:
                          _links: {}
                          hasDefault: false
                          name: Filter
                          required: true
                          type: QueryFilter
                          writable: true
                        name:
                          hasDefault: true
                          name: Name
                          required: true
                          type: String
                          writable: false
                    _links:
                      self:
                        href: /api/v3/workspaces/42/queries/filter_instance_schemas
                    _type: Collection
                    count: 2
                    total: 2
              schema:
                $ref: '#/components/schemas/Query_Filter_Instance_Schemas_For_WorkspaceModel'
          description: OK
          headers: {}
        '403':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:Unauthenticated
                    message: You are not authorized to access this resource.
          description: 'Returned if the client does not have sufficient permissions to see it.


            **Required permission:** view work package in any workspace'
          headers: {}
      tags:
      - Query Filter Instance Schema
      description: Returns the list of QueryFilterInstanceSchemas defined for a query of the specified workspace.
      operationId: List_Query_Filter_Instance_Schemas_for_Workspace
      summary: List Query Filter Instance Schemas for Workspace
components:
  schemas:
    Query_Filter_Instance_SchemaModel:
      type: object
      required:
      - name
      - _links
      properties:
        name:
          type: string
          description: Describes the name attribute
          readOnly: true
        _links:
          type: object
          required:
          - self
          - filter
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This QueryFilterInstanceSchema (same as for schema)


                  **Resource**: QueryFilterInstanceSchema'
                readOnly: true
            filter:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The filter for which this schema is specific


                  **Resource**: Filter'
                readOnly: true
      example:
        _type: QueryFilterInstanceSchema
        _dependencies:
        - _type: SchemaDependency
          'on': operator
          dependencies:
            /api/v3/queries/operators/=:
              values:
                type: '[]User'
                name: Values
                required: true
                hasDefault: false
                writable: true
                _links: {}
            /api/v3/queries/operators/!:
              values:
                type: '[]User'
                name: Values
                required: true
                hasDefault: false
                writable: true
                _links: {}
        name: A name
        _links:
          self:
            href: /api/v3/queries/filter_instance_schemas/author
          filter:
            href: /api/v3/queries/filters/author
            title: Author
    Link:
      type: object
      required:
      - href
      properties:
        href:
          type:
          - string
          - 'null'
          description: URL to the referenced resource (might be relative)
        title:
          type: string
          description: Representative label for the resource
        templated:
          type: boolean
          default: false
          description: If true the href contains parts that need to be replaced by the client
        method:
          type: string
          default: GET
          description: The HTTP verb to use when requesting the resource
        payload:
          type: object
          description: The payload to send in the request to achieve the desired result
        identifier:
          type: string
          description: An optional unique identifier to the link object
        type:
          type: string
          description: The MIME-Type of the returned resource.
      example:
        href: /api/v3/work_packages
        method: POST
    Query_Filter_Instance_SchemasModel:
      type: object
      example:
        _type: Collection
        total: 2
        count: 2
        _embedded:
          elements:
          - _type: QueryFilterInstanceSchema
            _dependencies:
            - _type: SchemaDependency
              'on': operator
              dependencies:
                /api/v3/queries/operators/=:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
                /api/v3/queries/operators/!:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
                /api/v3/queries/operators/!*: {}
                /api/v3/queries/operators/*: {}
            name:
              type: String
              name: Name
              required: true
              hasDefault: true
              writable: false
            filter:
              type: QueryFilter
              name: Filter
              required: true
              hasDefault: false
              writable: true
              _links: {}
            _links:
              self:
                href: /api/v3/queries/filter_instance_schemas/assignee
              filter:
                href: /api/v3/queries/filters/assignee
                title: Assignee
          - _type: QueryFilterInstanceSchema
            _dependencies:
            - _type: SchemaDependency
              'on': operator
              dependencies:
                /api/v3/queries/operators/=:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
                /api/v3/queries/operators/!:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
            name:
              type: String
              name: Name
              required: true
              hasDefault: true
              writable: false
            filter:
              type: QueryFilter
              name: Filter
              required: true
              hasDefault: false
              writable: true
              _links: {}
            _links:
              self:
                href: /api/v3/queries/filter_instance_schemas/author
              filter:
                href: /api/v3/queries/filters/author
                title: Author
        _links:
          self:
            href: /api/v3/queries/filter_instance_schemas
    ErrorResponse:
      type: object
      required:
      - _type
      - errorIdentifier
      - message
      properties:
        _embedded:
          type: object
          properties:
            details:
              type: object
              properties:
                attribute:
                  type: string
                  example: project
        _type:
          type: string
          enum:
          - Error
        errorIdentifier:
          type: string
          example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
        message:
          type: string
          example: Project can't be blank.
    Query_Filter_Instance_Schemas_For_WorkspaceModel:
      type: object
      example:
        _type: Collection
        total: 2
        count: 2
        _embedded:
          elements:
          - _type: QueryFilterInstanceSchema
            _dependencies:
            - _type: SchemaDependency
              'on': operator
              dependencies:
                /api/v3/queries/operators/=:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
                /api/v3/queries/operators/!:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
                /api/v3/queries/operators/!*: {}
                /api/v3/queries/operators/*: {}
            name:
              type: String
              name: Name
              required: true
              hasDefault: true
              writable: false
            filter:
              type: QueryFilter
              name: Filter
              required: true
              hasDefault: false
              writable: true
              _links: {}
            _links:
              self:
                href: /api/v3/queries/filter_instance_schemas/assignee
              filter:
                href: /api/v3/queries/filters/assignee
                title: Assignee
          - _type: QueryFilterInstanceSchema
            _dependencies:
            - _type: SchemaDependency
              'on': operator
              dependencies:
                /api/v3/queries/operators/=:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
                /api/v3/queries/operators/!:
                  values:
                    type: '[]User'
                    name: Values
                    required: true
                    hasDefault: false
                    writable: true
                    _links: {}
            name:
              type: String
              name: Name
              required: true
              hasDefault: true
              writable: false
            filter:
              type: QueryFilter
              name: Filter
              required: true
              hasDefault: false
              writable: true
              _links: {}
            _links:
              self:
                href: /api/v3/queries/filter_instance_schemas/author
              filter:
                href: /api/v3/queries/filters/author
                title: Author
        _links:
          self:
            href: /api/v3/workspaces/42/queries/filter_instance_schemas
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic