Taskfolk

Taskfolk Custom fields API

The Custom fields API from Taskfolk — 4 operation(s) for custom fields.

GitHub OpenAPI

Operations 7

GET /v1/workspaces/{slug}/projects/{key}/issues/{issueKey}/custom-fields List custom-field values on an issue #
PUT /v1/workspaces/{slug}/projects/{key}/issues/{issueKey}/custom-fields/{fieldId} Set a custom-field value #
DELETE /v1/workspaces/{slug}/projects/{key}/issues/{issueKey}/custom-fields/{fieldId} Clear a custom-field value #
GET /v1/workspaces/{slug}/projects/{key}/custom-field-defs List custom-field definitions #
POST /v1/workspaces/{slug}/projects/{key}/custom-field-defs Create a custom-field definition #
PATCH /v1/workspaces/{slug}/projects/{key}/custom-field-defs/{id} Update a custom-field definition #
DELETE /v1/workspaces/{slug}/projects/{key}/custom-field-defs/{id} Delete a custom-field definition #

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-custom-fields-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-custom-fields-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-custom-fields-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Taskfolk Custom fields 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: Custom Fields
paths:
  /v1/workspaces/{slug}/projects/{key}/issues/{issueKey}/custom-fields:
    get:
      summary: List custom-field values on an issue
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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
      - schema:
          type: string
          example: WEB-39
          description: Issue key (KEY-N).
        required: true
        description: Issue key (KEY-N).
        name: issueKey
        in: path
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomFieldValue'
                  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: getV1WorkspacesBySlugProjectsByKeyIssuesByIssueKeyCustomFields
      x-operation-id-source: derived
  /v1/workspaces/{slug}/projects/{key}/issues/{issueKey}/custom-fields/{fieldId}:
    put:
      summary: Set a custom-field value
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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: WEB-39
          description: Issue key (KEY-N).
        required: true
        description: Issue key (KEY-N).
        name: issueKey
        in: path
      - schema:
          type: string
        required: true
        name: fieldId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomFieldValueInput'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomFieldValue'
                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: putV1WorkspacesBySlugProjectsByKeyIssuesByIssueKeyCustomFieldsByFieldId
      x-operation-id-source: derived
    delete:
      summary: Clear a custom-field value
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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: WEB-39
          description: Issue key (KEY-N).
        required: true
        description: Issue key (KEY-N).
        name: issueKey
        in: path
      - schema:
          type: string
        required: true
        name: fieldId
        in: path
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomFieldValue'
                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: deleteV1WorkspacesBySlugProjectsByKeyIssuesByIssueKeyCustomFieldsByFieldId
      x-operation-id-source: derived
  /v1/workspaces/{slug}/projects/{key}/custom-field-defs:
    get:
      summary: List custom-field definitions
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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
      - schema:
          type: string
        required: false
        name: cursor
        in: query
      - schema:
          type:
          - integer
          - 'null'
        required: false
        name: limit
        in: query
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomFieldDef'
                  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: getV1WorkspacesBySlugProjectsByKeyCustomFieldDefs
      x-operation-id-source: derived
    post:
      summary: Create a custom-field definition
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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/CustomFieldDefCreateInput'
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomFieldDef'
                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: postV1WorkspacesBySlugProjectsByKeyCustomFieldDefs
      x-operation-id-source: derived
  /v1/workspaces/{slug}/projects/{key}/custom-field-defs/{id}:
    patch:
      summary: Update a custom-field definition
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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:
              type: object
              properties:
                name:
                  type: string
                kind:
                  type: string
                  enum:
                  - text
                  - number
                  - select
                  - multi_select
                  - date
                  - checkbox
                  - url
                  - user
                  - project
                  - doc
                options:
                  type: array
                  items:
                    type: string
                applies_to:
                  type: array
                  items:
                    type: string
                    enum:
                    - epic
                    - story
                    - task
                    - bug
                    - subtask
                required:
                  type: boolean
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CustomFieldDef'
                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: patchV1WorkspacesBySlugProjectsByKeyCustomFieldDefsById
      x-operation-id-source: derived
    delete:
      summary: Delete a custom-field definition
      tags:
      - Custom Fields
      security:
      - bearerAuth:
        - custom_fields: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
                    required:
                    - id
                    - 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: deleteV1WorkspacesBySlugProjectsByKeyCustomFieldDefsById
      x-operation-id-source: derived
components:
  schemas:
    CustomFieldValue:
      type: object
      properties:
        field_id:
          type: string
        name:
          type: string
        kind:
          type: string
        value: {}
      required:
      - field_id
    CustomFieldDefCreateInput:
      type: object
      properties:
        name:
          type: string
        kind:
          type: string
          enum:
          - text
          - number
          - select
          - multi_select
          - date
          - checkbox
          - url
          - user
          - project
          - doc
        options:
          type: array
          items:
            type: string
        applies_to:
          type: array
          items:
            type: string
            enum:
            - epic
            - story
            - task
            - bug
            - subtask
        required:
          type: boolean
      required:
      - name
      - kind
    Pagination:
      type: object
      properties:
        next_cursor:
          type:
          - string
          - 'null'
          example: null
      required:
      - next_cursor
    CustomFieldDef:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          example: severity
        kind:
          type: string
          enum:
          - text
          - number
          - select
          - multi_select
          - date
          - checkbox
          - url
          - user
          - project
          - doc
        options:
          type: array
          items:
            type: string
        applies_to:
          type: array
          items:
            type: string
            enum:
            - epic
            - story
            - task
            - bug
            - subtask
        required:
          type: boolean
        rank:
          type: string
      required:
      - id
      - name
      - kind
      - options
      - applies_to
      - required
      - rank
    CustomFieldValueInput:
      type: object
      properties:
        value: {}
    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.'