LeanKit board-filter API

openapi: 3.1.0
info:
  title: Planview AgilePlace API (LeanKit) v2 account board-filter API
  version: v2
  description: RESTful API for Planview AgilePlace (formerly LeanKit) Kanban boards, cards, lanes, connections, automations, teams, and planning increments. All requests use HTTPS against https://<yourhostname>.leankit.com/io/. Data is sent and received as JSON. Transcribed from the published Planview AgilePlace API reference — no endpoints invented.
  contact:
    name: Planview AgilePlace Support
    url: https://success.planview.com/Planview_AgilePlace/Support
  x-generated-by: API Evangelist enrichment pipeline — transcribed from the published Planview AgilePlace API reference
servers:
- url: https://{account}.leankit.com/io
  description: Per-account AgilePlace host
  variables:
    account:
      default: myaccount
      description: Your AgilePlace account subdomain
security:
- bearerToken: []
- basicAuth: []
tags:
- name: board-filter
paths:
  /board/{boardId}/filter:
    post:
      operationId: boardFilterCreate
      summary: Create a board filter
      tags:
      - board-filter
      externalDocs:
        description: Provider reference
        url: https://success.planview.com/Planview_AgilePlace/AgilePlace_API/01_v2/board-filter/create
      description: Create a board filter. Request Properties
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
        description: boardId identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid Basic/Bearer credentials
        '403':
          description: Forbidden - authenticated user lacks permission
        '404':
          description: Not found
        '422':
          description: Unprocessable entity - required information was missing or invalid
        '429':
          description: Too Many Requests - rate limit exceeded; see Retry-After and X-RateLimit-Reset headers
          headers:
            Retry-After:
              description: HTTP-date after which the client may retry
              schema:
                type: string
        '500':
          description: Server error on the AgilePlace side
        '201':
          description: Created
          content:
            application/json:
              schema:
                type: object
    get:
      operationId: boardFilterList
      summary: Get a list of board filters for a board
      tags:
      - board-filter
      externalDocs:
        description: Provider reference
        url: https://success.planview.com/Planview_AgilePlace/AgilePlace_API/01_v2/board-filter/list
      description: Get a list of board filters for a board. Example Request
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
        description: boardId identifier
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid Basic/Bearer credentials
        '403':
          description: Forbidden - authenticated user lacks permission
        '404':
          description: Not found
        '422':
          description: Unprocessable entity - required information was missing or invalid
        '429':
          description: Too Many Requests - rate limit exceeded; see Retry-After and X-RateLimit-Reset headers
          headers:
            Retry-After:
              description: HTTP-date after which the client may retry
              schema:
                type: string
        '500':
          description: Server error on the AgilePlace side
  /board/{boardId}/filter/{filterId}:
    delete:
      operationId: boardFilterDelete
      summary: Delete a board filter
      tags:
      - board-filter
      externalDocs:
        description: Provider reference
        url: https://success.planview.com/Planview_AgilePlace/AgilePlace_API/01_v2/board-filter/delete
      description: Delete a board filter. Example Request
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
        description: boardId identifier
      - name: filterId
        in: path
        required: true
        schema:
          type: string
        description: filterId identifier
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid Basic/Bearer credentials
        '403':
          description: Forbidden - authenticated user lacks permission
        '404':
          description: Not found
        '422':
          description: Unprocessable entity - required information was missing or invalid
        '429':
          description: Too Many Requests - rate limit exceeded; see Retry-After and X-RateLimit-Reset headers
          headers:
            Retry-After:
              description: HTTP-date after which the client may retry
              schema:
                type: string
        '500':
          description: Server error on the AgilePlace side
        '204':
          description: Deleted
    get:
      operationId: boardFilterGet
      summary: Get a board filter by id
      tags:
      - board-filter
      externalDocs:
        description: Provider reference
        url: https://success.planview.com/Planview_AgilePlace/AgilePlace_API/01_v2/board-filter/get
      description: Get a board filter by id. Example Request
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
        description: boardId identifier
      - name: filterId
        in: path
        required: true
        schema:
          type: string
        description: filterId identifier
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid Basic/Bearer credentials
        '403':
          description: Forbidden - authenticated user lacks permission
        '404':
          description: Not found
        '422':
          description: Unprocessable entity - required information was missing or invalid
        '429':
          description: Too Many Requests - rate limit exceeded; see Retry-After and X-RateLimit-Reset headers
          headers:
            Retry-After:
              description: HTTP-date after which the client may retry
              schema:
                type: string
        '500':
          description: Server error on the AgilePlace side
    patch:
      operationId: boardFilterUpdate
      summary: Update a board filter Request Properties
      tags:
      - board-filter
      externalDocs:
        description: Provider reference
        url: https://success.planview.com/Planview_AgilePlace/AgilePlace_API/01_v2/board-filter/update
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
        description: boardId identifier
      - name: filterId
        in: path
        required: true
        schema:
          type: string
        description: filterId identifier
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
        '401':
          description: Unauthorized - missing or invalid Basic/Bearer credentials
        '403':
          description: Forbidden - authenticated user lacks permission
        '404':
          description: Not found
        '422':
          description: Unprocessable entity - required information was missing or invalid
        '429':
          description: Too Many Requests - rate limit exceeded; see Retry-After and X-RateLimit-Reset headers
          headers:
            Retry-After:
              description: HTTP-date after which the client may retry
              schema:
                type: string
        '500':
          description: Server error on the AgilePlace side
components:
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      description: API token created via POST /io/auth/token or the "My API Tokens" tab in the AgilePlace user profile. Tokens do not expire; revoke unused tokens.
    basicAuth:
      type: http
      scheme: basic
      description: Base64-encoded AgilePlace email and password.
externalDocs:
  description: Planview AgilePlace API reference
  url: https://success.planview.com/Planview_AgilePlace/AgilePlace_API