Karbon · Schema

IntegrationTasks

A list of Integration Tasks

CompanyAccountingPractice ManagementWorkflowsCollaborationProfessional ServicesSoftware-as-a-Service

Properties

Name Type Description
@odata.context string
@odata.count number
value array
View JSON Schema on GitHub

JSON Schema

karbonhq-integration-tasks-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-integration-tasks-schema.json",
  "title": "IntegrationTasks",
  "description": "A list of Integration Tasks",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karbonhq-integrated-workflows-api-openapi.yml#/components/schemas/IntegrationTasks",
  "type": "object",
  "properties": {
    "@odata.context": {
      "type": "string",
      "format": "uri"
    },
    "@odata.count": {
      "type": "number",
      "format": "int32"
    },
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/IntegrationTask"
      }
    }
  },
  "$defs": {
    "IntegrationTask": {
      "description": "A single Integration Task",
      "allOf": [
        {
          "$ref": "#/$defs/IntegrationTaskReadOnly"
        },
        {
          "$ref": "#/$defs/IntegrationTaskWriteable"
        }
      ]
    },
    "IntegrationTaskData": {
      "type": "object",
      "description": "Optional integration task data key/value pairs",
      "properties": {
        "Key": {
          "type": "string"
        },
        "Value": {
          "type": "string"
        }
      }
    },
    "IntegrationTaskReadOnly": {
      "type": "object",
      "description": "The read-only properties of an Integration Task",
      "properties": {
        "CreatedAt": {
          "type": "string"
        },
        "TaskDefinitionKey": {
          "type": "string",
          "description": "The unique ID of the integration task definition"
        },
        "TaskKey": {
          "type": "string",
          "description": "The unique key of the specific Integration Task Definition for the associated Karbon account"
        },
        "Locale": {
          "description": "The list of locales and languages the integration task definition is suitable for use with, useful when different definitions are required for different languages or locales",
          "type": "string"
        },
        "WorkItemKey": {
          "type": "string"
        },
        "WorkItemClientKey": {
          "type": "string"
        },
        "WorkType": {
          "type": "string"
        }
      }
    },
    "IntegrationTaskWriteable": {
      "type": "object",
      "description": "The writable properties of an Integration Task",
      "properties": {
        "TaskName": {
          "type": "string",
          "maxLength": 200,
          "description": "The name of the specific Integration Task Definition"
        },
        "TaskPrimaryLinkUrl": {
          "oneOf": [
            {
              "type": "string",
              "format": "uri",
              "maxLength": 200
            },
            {
              "type": "null"
            }
          ],
          "description": "The optional default primary link URL of the specific Integration Task Definition"
        },
        "TaskPrimaryLinkLabel": {
          "oneOf": [
            {
              "type": "string",
              "maxLength": 20
            },
            {
              "type": "null"
            }
          ],
          "description": "The optional default label for the primary link URL of the specific Integration Task Definition"
        },
        "TaskSecondaryLinkUrl": {
          "oneOf": [
            {
              "type": "string",
              "format": "uri",
              "maxLength": 200
            },
            {
              "type": "null"
            }
          ],
          "description": "The optional default label for the secondary link URL of the specific Integration Task Definition"
        },
        "TaskSecondaryLinkLabel": {
          "oneOf": [
            {
              "type": "string",
              "maxLength": 20
            },
            {
              "type": "null"
            }
          ],
          "description": "The optional default label for the secondary link URL of the specific Integration Task Definition"
        },
        "TaskStatus": {
          "type": "string",
          "maxLength": 50
        },
        "PrimaryStatus": {
          "type": "string",
          "enum": [
            "Planned",
            "ReadyToStart",
            "InProgress",
            "Waiting",
            "Completed"
          ]
        },
        "TaskDueDate": {
          "type": "string"
        },
        "TaskData": {
          "type": "array",
          "description": "Key/value metadata for the task. The combined serialized content must not exceed 4000 characters.",
          "items": {
            "$ref": "#/$defs/IntegrationTaskData"
          }
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • 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 JSON Schema
curl "https://apis.io/api/v1/json-schemas/karbonhq-integration-tasks"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

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