Charthop

Charthop task-config API

The task-config API from Charthop — 2 operation(s) for task-config.

GitHub OpenAPI

Operations 4

GET /v1/org/{orgId}/task-config Get all task configs for an org #
POST /v1/org/{orgId}/task-config Create a new task config #
GET /v1/org/{orgId}/task-config/{id} Get a specific task config #
PATCH /v1/org/{orgId}/task-config/{id} Update an existing task config #

Documentation

📖
Documentation
https://docs.charthop.com/developer-basics

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/charthop/refs/heads/main/openapi/charthop-task-config-api-openapi.yml

Other Resources

🔗
Swagger
https://api.charthop.com/swagger

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/charthop-task-config-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 email required.

GitHub Google LinkedIn

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

OpenAPI Specification

charthop-task-config-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: REST API for ChartHop
  version: V1.0.0
  title: ChartHop access Task Config API
  contact:
    name: ChartHop
    url: https://www.charthop.com
    email: support@charthop.com
servers:
- url: https://localhost
- url: http://localhost
tags:
- name: task-config
paths:
  /v1/org/{orgId}/task-config:
    get:
      tags:
      - task-config
      summary: Get all task configs for an org
      operationId: findTaskConfigs
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: from
        in: query
        description: TaskConfig id to start paginating from
        required: false
        schema:
          type: string
      - name: parentEntityId
        in: query
        description: ParentEntityId to query for
        required: false
        schema:
          type: string
      - name: assessmentId
        in: query
        description: AssessmentId to query for
        required: false
        schema:
          type: string
      - name: entityId
        in: query
        description: EntityId to query for
        required: false
        schema:
          type: string
      - name: limit
        in: query
        description: Number of results to return
        required: false
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultsTaskConfig'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    post:
      tags:
      - task-config
      summary: Create a new task config
      operationId: createTaskConfig
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug
        required: true
        schema:
          type: string
      responses:
        '201':
          description: task config created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskConfig'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTaskConfig'
        description: Task config to create
        required: true
  /v1/org/{orgId}/task-config/{id}:
    get:
      tags:
      - task-config
      summary: Get a specific task config
      operationId: getTaskConfig
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug)
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of the desired task config
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaskConfig'
        '400':
          description: bad request
        '401':
          description: not authorized
        '404':
          description: not found
    patch:
      tags:
      - task-config
      summary: Update an existing task config
      operationId: updateTaskConfig
      parameters:
      - name: orgId
        in: path
        description: Org identifier (either id or slug
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: ID of the desired task config
        required: true
        schema:
          type: string
      responses:
        '204':
          description: successful operation
        '400':
          description: invalid data
        '401':
          description: not authorized
        '403':
          description: permission denied
        '404':
          description: not found
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTaskConfig'
        description: Task config to create
        required: true
components:
  schemas:
    Attribution:
      type: object
      properties:
        principalUserId:
          type: string
          example: 588f7ee98f138b19220041a7
        agentUserIds:
          type: array
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        eventId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiChatId:
          type: string
          example: 588f7ee98f138b19220041a7
        aiToolUseId:
          type: string
        channel:
          type: string
          enum:
          - WEB
          - MOBILE
          - SLACK
          - TEAMS
          - MCP
    CreateTaskConfig:
      type: object
      required:
      - entityId
      - type
      - pastDueAction
      properties:
        assessmentId:
          type: string
          description: parent assessment id that this task config belongs to
          example: 588f7ee98f138b19220041a7
        parentEntityId:
          type: string
          description: parent entity id that this task config belongs to, should be used with entityId
          example: 588f7ee98f138b19220041a7
        entityId:
          type: string
          description: the primary entity being referenced by the task config
          example: 588f7ee98f138b19220041a7
        type:
          type: string
          description: type of task generated by the task config
          enum:
          - FORM_SUBMIT
          - FORM_RESPONSE_APPROVE
          - FORM_RESPONSE_RESUBMIT
          - CHANGE_APPROVE
          - TIMEOFF_APPROVE
          - SCENARIO_CHANGES_APPROVE
          - SCENARIO_CHANGES_CREATE
          - ORG_IMPORT
          - COMP_REVIEW_APPROVAL_SUBMIT
          - SCENARIO_APPROVAL_SUBMIT
          - APPROVAL_CHAIN_UPDATE_FALLBACK_APPROVER
          - ACTION
          - SIGNATURE
          - GOAL_PROGRESS
          - TODO
        dueDate:
          description: date object for tasks, can be relative or exact
          $ref: '#/components/schemas/DueDate'
        pastDueAction:
          type: string
          description: sets pastDueAction on the task when it's generated
          enum:
          - NONE
          - SET_EXPIRED
        isSkippable:
          type: boolean
          description: sets isSkippable on the task
        label:
          type: string
          description: human-readable label that should be used for all tasks associated with the config as the task name
        description:
          type: string
          description: description for all tasks associated with the config that should be used in notifications
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
    ResultsAccess:
      type: object
      required:
      - allowed
      properties:
        ids:
          type: array
          uniqueItems: true
          items:
            type: string
            example: 588f7ee98f138b19220041a7
        allowed:
          type: array
          uniqueItems: true
          items:
            $ref: '#/components/schemas/AccessAction'
    UpdateTaskConfig:
      type: object
      properties:
        type:
          type: string
          description: type of task generated by the task config
          enum:
          - FORM_SUBMIT
          - FORM_RESPONSE_APPROVE
          - FORM_RESPONSE_RESUBMIT
          - CHANGE_APPROVE
          - TIMEOFF_APPROVE
          - SCENARIO_CHANGES_APPROVE
          - SCENARIO_CHANGES_CREATE
          - ORG_IMPORT
          - COMP_REVIEW_APPROVAL_SUBMIT
          - SCENARIO_APPROVAL_SUBMIT
          - APPROVAL_CHAIN_UPDATE_FALLBACK_APPROVER
          - ACTION
          - SIGNATURE
          - GOAL_PROGRESS
          - TODO
        dueDate:
          description: date object for tasks, can be relative or exact
          $ref: '#/components/schemas/DueDate'
        pastDueAction:
          type: string
          description: sets pastDueAction on the task when it's generated
          enum:
          - NONE
          - SET_EXPIRED
        isSkippable:
          type: boolean
          description: sets isSkippable on the task
        label:
          type: string
          description: human-readable label that should be used for all tasks associated with the config as the task name
        description:
          type: string
          description: description for all tasks associated with the config that should be used in notifications
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'
    DueDate:
      type: object
      required:
      - type
      - dueDay
      - dueTime
      properties:
        type:
          type: string
          enum:
          - EXACT
          - RELATIVE
        dueDay:
          type: string
          description: due day, in either relative (-7d) or exact (YYYY-MM-DD) format
        dueTime:
          type: string
          description: due time, which is a LocalTime
    ResultsTaskConfig:
      type: object
      required:
      - data
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TaskConfig'
        next:
          type: string
        access:
          type: array
          items:
            $ref: '#/components/schemas/ResultsAccess'
    AccessAction:
      type: object
      required:
      - action
      properties:
        action:
          type: string
        fields:
          type: array
          uniqueItems: true
          items:
            type: string
        types:
          type: array
          uniqueItems: true
          items:
            type: string
    TaskConfig:
      type: object
      required:
      - id
      - orgId
      - entityId
      - slug
      - type
      - pastDueAction
      properties:
        id:
          type: string
          description: unique id of task config
          example: 588f7ee98f138b19220041a7
        orgId:
          type: string
          description: parent organization id
          example: 588f7ee98f138b19220041a7
        assessmentId:
          type: string
          description: parent assessment id that this task config belongs to
          example: 588f7ee98f138b19220041a7
        parentEntityId:
          type: string
          description: parent entity id that this task config belongs to, should be used with entityId
          example: 588f7ee98f138b19220041a7
        entityId:
          type: string
          description: the primary entity being referenced by the task config
          example: 588f7ee98f138b19220041a7
        slug:
          type: string
          description: System generated identifying name so that actions can be triggered as a result of task completion
        type:
          type: string
          description: type of task generated by the task config
          enum:
          - FORM_SUBMIT
          - FORM_RESPONSE_APPROVE
          - FORM_RESPONSE_RESUBMIT
          - CHANGE_APPROVE
          - TIMEOFF_APPROVE
          - SCENARIO_CHANGES_APPROVE
          - SCENARIO_CHANGES_CREATE
          - ORG_IMPORT
          - COMP_REVIEW_APPROVAL_SUBMIT
          - SCENARIO_APPROVAL_SUBMIT
          - APPROVAL_CHAIN_UPDATE_FALLBACK_APPROVER
          - ACTION
          - SIGNATURE
          - GOAL_PROGRESS
          - TODO
        dueDate:
          description: date object for tasks, can be relative or exact
          $ref: '#/components/schemas/DueDate'
        pastDueAction:
          type: string
          description: sets pastDueAction on the task when it's generated
          enum:
          - NONE
          - SET_EXPIRED
        isSkippable:
          type: boolean
          description: sets isSkippable on the task
        label:
          type: string
          description: human-readable label that should be used for all tasks associated with the config as the task name
        description:
          type: string
          description: description for all tasks associated with the config that should be used in notifications
        createId:
          type: string
          description: created by user id
          example: 588f7ee98f138b19220041a7
        createBehalfId:
          type: string
          description: created on behalf of user id
          example: 588f7ee98f138b19220041a7
        createAttribution:
          $ref: '#/components/schemas/Attribution'
        createAt:
          type: string
          description: created timestamp
          example: '2017-01-24T13:57:52Z'
        updateId:
          type: string
          description: last updated by user id
          example: 588f7ee98f138b19220041a7
        updateBehalfId:
          type: string
          description: last updated on behalf of user id
          example: 588f7ee98f138b19220041a7
        updateAttribution:
          $ref: '#/components/schemas/Attribution'
        updateAt:
          type: string
          description: last updated timestamp
          example: '2017-01-24T13:57:52Z'
        deleteId:
          type: string
          description: deleted by user id
          example: 588f7ee98f138b19220041a7
        deleteBehalfId:
          type: string
          description: deleted on behalf of user id
          example: 588f7ee98f138b19220041a7
        deleteAttribution:
          $ref: '#/components/schemas/Attribution'
        deleteAt:
          type: string
          description: deleted timestamp
          example: '2017-01-24T13:57:52Z'