Karbon · Schema

GetWorkItems

A collection of work items

CompanyAccountingPractice ManagementWorkflowsCollaborationProfessional ServicesSoftware-as-a-Service

Properties

Name Type Description
@odata.context string The information about Karbon controllers generating this response.
@odata.count integer The total number of Work Items that satisfy the query criteria.
value array
@odata.nextLink string The link to next set of Work Items. @odata.nextLink field will only appear if you have more than 100 Work Items.
View JSON Schema on GitHub

JSON Schema

karbonhq-get-work-items-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-get-work-items-schema.json",
  "title": "GetWorkItems",
  "description": "A collection of work items",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karbonhq-work-items-api-openapi.yml#/components/schemas/GetWorkItems",
  "required": [
    "value",
    "@odata.context",
    "@odata.count"
  ],
  "type": "object",
  "properties": {
    "@odata.context": {
      "type": "string",
      "description": "The information about Karbon controllers generating this response."
    },
    "@odata.count": {
      "type": "integer",
      "format": "int64",
      "description": "The total number of Work Items that satisfy the query criteria."
    },
    "value": {
      "type": "array",
      "items": {
        "allOf": [
          {
            "type": "object",
            "properties": {
              "@odata.type": {
                "type": "string",
                "description": "The information about Karbon Objects generating this response."
              }
            }
          },
          {
            "$ref": "#/$defs/WorkItem"
          }
        ]
      }
    },
    "@odata.nextLink": {
      "type": "string",
      "description": "The link to next set of Work Items. @odata.nextLink field will only appear if you have more than 100 Work Items."
    }
  },
  "$defs": {
    "WorkItem": {
      "description": "The base data for a Work Item",
      "required": [
        "ClientKey",
        "StartDate",
        "Title",
        "WorkItemKey"
      ],
      "type": "object",
      "properties": {
        "WorkItemKey": {
          "type": "string",
          "description": "A Karbon-generated unique identifier for the Work Item"
        },
        "AssigneeEmailAddress": {
          "type": "string",
          "description": "The email address of the user to whom the Work Item has been assigned"
        },
        "AssigneeKey": {
          "type": "string",
          "description": "A Karbon-generated value used to identify the user to whom the Work Item has been assigned"
        },
        "AssigneeName": {
          "type": "string",
          "description": "The name of the user to whom the Work Item has been assigned"
        },
        "Title": {
          "type": "string",
          "description": "The title of the Work Item"
        },
        "ClientKey": {
          "type": "string",
          "description": "A Karbon-generated value used to identify the Client for whom the Work Item is prepared"
        },
        "ClientName": {
          "type": "string",
          "description": "The name of the Client for whom the Work Item is prepared"
        },
        "ClientType": {
          "type": "string",
          "enum": [
            "Contact",
            "Organization",
            "ClientGroup"
          ],
          "description": "The type of the Client"
        },
        "ClientUserDefinedIdentifier": {
          "type": "string",
          "description": "A unique identifier that you had created to identify the Client. This parameter is not case sensitive."
        },
        "RelatedClientGroupKey": {
          "type": "string",
          "description": "A Karbon-generated value used to identify the Client Group of the Client"
        },
        "ClientGroupKey": {
          "type": "string",
          "description": "A Karbon-generated value used to identify the Client Group of the Client"
        },
        "RelatedClientGroupName": {
          "type": "string",
          "description": "The name of the related Client Group"
        },
        "StartDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time at which the Work Item should start"
        },
        "DueDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time by which the Work Item should be complete"
        },
        "DeadlineDate": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time",
          "description": "The date and time by which the Work Item should be complete according to a party outside of your firm. e.g. A tax filing date or payroll processing cut-off date."
        },
        "CompletedDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time at which the Work Item was completed"
        },
        "ToDoPeriod": {
          "type": "string",
          "format": "date-time",
          "description": "The period, in which the Work Item should start."
        },
        "WorkType": {
          "type": "string",
          "description": "The type of work related to the Work Item"
        },
        "WorkStatus": {
          "type": "string",
          "description": "The current status of the Work Item"
        },
        "PrimaryStatus": {
          "type": "string",
          "enum": [
            "Planned",
            "ReadyToStart",
            "InProgress",
            "Waiting",
            "Completed"
          ],
          "description": "The current parent-level Status of the Work Item. If `WorkStatus` and `PrimaryStatus` have different values, `PrimaryStatus` will be the source of truth for Work Item status.\n"
        },
        "SecondaryStatus": {
          "type": "string",
          "description": "The current child-level Status of the Work Item"
        },
        "WorkTemplateKey": {
          "type": "string",
          "description": "A Karbon-generated value used to identify the Template that generated this Work Item"
        },
        "WorkTemplateTile": {
          "type": "string",
          "description": "The title of the Work Template"
        },
        "WorkScheduleKey": {
          "type": "string",
          "description": "A Karbon-generated value used to identify the Work Schedule for this Work Item"
        },
        "EstimatedBudget": {
          "deprecated": true,
          "type": "number",
          "format": "decimal",
          "description": "Deprecated! - previously used as the estimated budget for the Work Item"
        }
      }
    }
  }
}

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-get-work-items"
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.