Taskfolk

Taskfolk Key results API

The Key results API from Taskfolk — 2 operation(s) for key results.

GitHub OpenAPI
Business capability
Strategy Execution Management BC-100.20

Operations 4

GET /v1/workspaces/{slug}/goals/{goalId}/key-results List a goal's key results.
POST /v1/workspaces/{slug}/goals/{goalId}/key-results Create a key result (manual metric or auto scope roll-up).
PATCH /v1/workspaces/{slug}/goals/{goalId}/key-results/{keyResultId} Update a key result.
DELETE /v1/workspaces/{slug}/goals/{goalId}/key-results/{keyResultId} Delete a key result (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-key-results-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-key-results-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-key-results-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Taskfolk Key results 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: Key results
paths:
  /v1/workspaces/{slug}/goals/{goalId}/key-results:
    get:
      summary: List a goal's key results.
      tags:
      - Key results
      security:
      - bearerAuth:
        - goals:read
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: 019e6f12-…
          description: Goal id.
        required: true
        description: Goal id.
        name: goalId
        in: path
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KeyResult'
                  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'
    post:
      summary: Create a key result (manual metric or auto scope roll-up).
      tags:
      - Key results
      security:
      - bearerAuth:
        - goals:write
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: 019e6f12-…
          description: Goal id.
        required: true
        description: Goal id.
        name: goalId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyResultCreateInput'
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/KeyResult'
                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'
  /v1/workspaces/{slug}/goals/{goalId}/key-results/{keyResultId}:
    patch:
      summary: Update a key result.
      tags:
      - Key results
      security:
      - bearerAuth:
        - goals:write
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: 019e6f12-…
          description: Goal id.
        required: true
        description: Goal id.
        name: goalId
        in: path
      - schema:
          type: string
          example: 019e6f12-…
          description: Key result id.
        required: true
        description: Key result id.
        name: keyResultId
        in: path
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/KeyResultPatchInput'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/KeyResult'
                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'
    delete:
      summary: Delete a key result (soft).
      tags:
      - Key results
      security:
      - bearerAuth:
        - goals:write
      parameters:
      - schema:
          type: string
          example: taskfolk
          description: Workspace slug.
        required: true
        description: Workspace slug.
        name: slug
        in: path
      - schema:
          type: string
          example: 019e6f12-…
          description: Goal id.
        required: true
        description: Goal id.
        name: goalId
        in: path
      - schema:
          type: string
          example: 019e6f12-…
          description: Key result id.
        required: true
        description: Key result id.
        name: keyResultId
        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'
components:
  schemas:
    Pagination:
      type: object
      properties:
        next_cursor:
          type:
          - string
          - 'null'
          example: null
      required:
      - next_cursor
    KeyResultCreateInput:
      type: object
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 200
        kind:
          type: string
          enum:
          - manual
          - auto
        unit:
          type:
          - string
          - 'null'
          maxLength: 24
        start_value:
          type:
          - number
          - 'null'
        target_value:
          type:
          - number
          - 'null'
        current_value:
          type:
          - number
          - 'null'
        weight:
          type: number
          exclusiveMinimum: 0
          maximum: 999
          description: Relative weight in the goal roll-up (default 1).
        scope:
          type:
          - object
          - 'null'
          properties:
            project_ids:
              type: array
              items:
                type: string
            issue_types:
              type: array
              items:
                type: string
                enum:
                - epic
                - story
                - task
                - bug
                - subtask
            label_ids:
              type: array
              items:
                type: string
            assignee_id:
              type:
              - string
              - 'null'
          description: Auto KRs only; ignored for manual.
      required:
      - title
      - kind
    KeyResult:
      type: object
      properties:
        id:
          type: string
        goal_id:
          type: string
        title:
          type: string
        kind:
          type: string
          enum:
          - manual
          - auto
        unit:
          type:
          - string
          - 'null'
          example: '%'
        start_value:
          type:
          - number
          - 'null'
        target_value:
          type:
          - number
          - 'null'
        current_value:
          type:
          - number
          - 'null'
        weight:
          type: number
          example: 1
        scope:
          type:
          - object
          - 'null'
          properties:
            project_ids:
              type: array
              items:
                type: string
            issue_types:
              type: array
              items:
                type: string
                enum:
                - epic
                - story
                - task
                - bug
                - subtask
            label_ids:
              type: array
              items:
                type: string
            assignee_id:
              type:
              - string
              - 'null'
          description: Auto-KR work scope; null = inherit the goal's portfolio/workspace scope. Unknown ids are dropped.
        progress_pct:
          type:
          - integer
          - 'null'
        created_at:
          type: string
          format: date-time
          example: '2026-05-28T14:30:00Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-05-28T14:30:00Z'
      required:
      - id
      - goal_id
      - title
      - kind
      - unit
      - start_value
      - target_value
      - current_value
      - weight
      - scope
      - progress_pct
      - created_at
      - updated_at
    KeyResultPatchInput:
      type: object
      properties:
        title:
          type: string
          minLength: 1
          maxLength: 200
        unit:
          type:
          - string
          - 'null'
          maxLength: 24
        start_value:
          type:
          - number
          - 'null'
        target_value:
          type:
          - number
          - 'null'
        current_value:
          type:
          - number
          - 'null'
        weight:
          type: number
          exclusiveMinimum: 0
          maximum: 999
        scope:
          type:
          - object
          - 'null'
          properties:
            project_ids:
              type: array
              items:
                type: string
            issue_types:
              type: array
              items:
                type: string
                enum:
                - epic
                - story
                - task
                - bug
                - subtask
            label_ids:
              type: array
              items:
                type: string
            assignee_id:
              type:
              - string
              - 'null'
          description: Applied only to auto KRs.
    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.'