Taskfolk

Taskfolk Statuses API

The Statuses API from Taskfolk — 2 operation(s) for statuses.

GitHub OpenAPI

Operations 4

GET /v1/workspaces/{slug}/projects/{key}/statuses List a project's board statuses (ordered) #
POST /v1/workspaces/{slug}/projects/{key}/statuses Create a board status column (max 12 per project) #
PATCH /v1/workspaces/{slug}/projects/{key}/statuses/{id} Update a board status. Changing category re-categorises all issues in the column #
DELETE /v1/workspaces/{slug}/projects/{key}/statuses/{id} Delete a board status (soft). #

Documentation

📖
Documentation
https://taskfolk.ai/api/v1/reference
📖
APIReference
https://taskfolk.ai/api/v1/reference
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/authentication/taskfolk-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/rate-limits/taskfolk-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/openapi/taskfolk-statuses-api-openapi.yml

Other Resources

🔗
DeveloperPortal
https://taskfolk.ai/developer
🔗
ToolCrosswalk
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/mcp/taskfolk-tool-crosswalk.yml
🔗
AgentCard
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/a2a/taskfolk-a2a.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/scopes/taskfolk-scopes.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/asyncapi/taskfolk-webhooks.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/errors/taskfolk-problem-types.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/conventions/taskfolk-conventions.yml
🔗
Idempotency
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/conventions/taskfolk-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/data-model/taskfolk-data-model.yml
🔗
Plans
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/plans/taskfolk-plans-pricing.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/taskfolk/refs/heads/main/conformance/taskfolk-conformance.yml

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/taskfolk-statuses-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

taskfolk-statuses-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Taskfolk Statuses API
  version: 1.0.0
  description: Public REST API for Taskfolk (taskfolk.ai). All endpoints require a workspace-scoped bearer API key. Paths are nested under `/v1/workspaces/{slug}/…`.
servers:
- url: https://taskfolk.ai/api
security:
- bearerAuth: []
tags:
- name: Statuses
paths:
  /v1/workspaces/{slug}/projects/{key}/statuses:
    get:
      summary: List a project's board statuses (ordered)
      tags:
      - Statuses
      security:
      - bearerAuth:
        - projects:read
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: web
          description: Project key.
        required: true
        description: Project key.
        name: key
        in: path
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProjectStatus'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
                required:
                - data
                - pagination
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Missing / invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Resource not found (or cross-workspace — never leaked).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: getV1WorkspacesBySlugProjectsByKeyStatuses
      x-operation-id-source: derived
    post:
      summary: Create a board status column (max 12 per project)
      tags:
      - Statuses
      security:
      - bearerAuth:
        - projects:write
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: web
          description: Project key.
        required: true
        description: Project key.
        name: key
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StatusCreateInput'
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProjectStatus'
                required:
                - data
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Missing / invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Resource not found (or cross-workspace — never leaked).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: postV1WorkspacesBySlugProjectsByKeyStatuses
      x-operation-id-source: derived
  /v1/workspaces/{slug}/projects/{key}/statuses/{id}:
    patch:
      summary: Update a board status. Changing category re-categorises all issues in the column
      tags:
      - Statuses
      security:
      - bearerAuth:
        - projects:write
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: web
          description: Project key.
        required: true
        description: Project key.
        name: key
        in: path
      - schema:
          type: string
          example: 019e6f12-…
        required: true
        name: id
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StatusPatchInput'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ProjectStatus'
                required:
                - data
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Missing / invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Resource not found (or cross-workspace — never leaked).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: patchV1WorkspacesBySlugProjectsByKeyStatusesById
      x-operation-id-source: derived
    delete:
      summary: Delete a board status (soft).
      tags:
      - Statuses
      security:
      - bearerAuth:
        - projects:write
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: web
          description: Project key.
        required: true
        description: Project key.
        name: key
        in: path
      - schema:
          type: string
          example: 019e6f12-…
        required: true
        name: id
        in: path
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      deleted:
                        type: boolean
                        enum:
                        - true
                      issues_deleted:
                        type: integer
                    required:
                    - id
                    - deleted
                    - issues_deleted
                required:
                - data
        '400':
          description: Validation error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Missing / invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Key lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Resource not found (or cross-workspace — never leaked).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: deleteV1WorkspacesBySlugProjectsByKeyStatusesById
      x-operation-id-source: derived
components:
  schemas:
    ProjectStatus:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          example: In Review
        name_ar:
          type:
          - string
          - 'null'
          example: قيد المراجعة
        color:
          type: string
          example: '#4FE8E5'
        category:
          type: string
          enum:
          - backlog
          - todo
          - in_progress
          - in_review
          - done
          - failed
          - cancelled
          description: System category the status maps to (open/done semantics).
        rank:
          type: string
          description: LexoRank ordering string.
      required:
      - id
      - name
      - name_ar
      - color
      - category
      - rank
    StatusCreateInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
          example: In Review
        name_ar:
          type: string
          maxLength: 80
          example: قيد المراجعة
        color:
          type: string
          example: '#4FE8E5'
          description: 'Hex color #RRGGBB.'
        category:
          type: string
          enum:
          - backlog
          - todo
          - in_progress
          - in_review
          - done
          - failed
          - cancelled
          description: System category the column maps to (drives open/done semantics).
      required:
      - name
      - color
      - category
    Pagination:
      type: object
      properties:
        next_cursor:
          type:
          - string
          - 'null'
          example: null
      required:
      - next_cursor
    StatusPatchInput:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 80
        name_ar:
          type:
          - string
          - 'null'
          maxLength: 80
        color:
          type: string
          description: 'Hex color #RRGGBB.'
        category:
          type: string
          enum:
          - backlog
          - todo
          - in_progress
          - in_review
          - done
          - failed
          - cancelled
          description: System category the column maps to (drives open/done semantics).
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
              - unauthorized
              - forbidden
              - not_found
              - validation
              - rate_limited
              - conflict
              - idempotency_violation
              - internal_error
              example: validation
            message:
              type: string
              example: Label "foo" does not exist on this project.
            details:
              type: object
              additionalProperties: {}
          required:
          - code
          - message
      required:
      - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Workspace API key. Send as `Authorization: Bearer tfk_live_…`. Each key is bound to exactly one workspace and carries a set of scopes.'