Karbon · Schema

GetWorkTemplates

A collection of Work Templates

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 Templates that satisfy the query criteria.
value array
@odata.nextLink string The link to next set of Work Templates. @odata.nextLink field will only appear if you have more than 10 Work Templates.
View JSON Schema on GitHub

JSON Schema

karbonhq-get-work-templates-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-get-work-templates-schema.json",
  "title": "GetWorkTemplates",
  "description": "A collection of Work Templates",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karbonhq-work-templates-api-openapi.yml#/components/schemas/GetWorkTemplates",
  "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 Templates that satisfy the query criteria."
    },
    "value": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/GetSingleWorkTemplate"
      }
    },
    "@odata.nextLink": {
      "type": "string",
      "description": "The link to next set of Work Templates. @odata.nextLink field will only appear if you have more than 10 Work Templates."
    }
  },
  "$defs": {
    "GetSingleWorkTemplate": {
      "description": "A single Work Template",
      "required": [
        "WorkTemplateKey",
        "WorkTypeKey",
        "HasScheduledClientTaskGroups",
        "DraftHasChanges",
        "PublishedDate",
        "NumberOfWorkItemsCreated",
        "DateLastWorkItemCreated",
        "DateModified"
      ],
      "type": "object",
      "properties": {
        "WorkTemplateKey": {
          "type": "string",
          "description": "A Karbon-generated unique identifier for the Work Template"
        },
        "Title": {
          "type": "string",
          "description": "The title of the Work Template"
        },
        "Description": {
          "type": "string",
          "description": "A free text field to add more information about the Work Template"
        },
        "WorkTypeKey": {
          "type": "string",
          "description": "A Karbon-generated unique identifier to denote the Work Type"
        },
        "HasScheduledClientTaskGroups": {
          "type": "boolean",
          "description": "This property is set to true, if the Work Template has scheduled Client Tasks"
        },
        "EstimatedBudget": {
          "type": [
            "string",
            "null"
          ],
          "description": "The estimated budget for the Work Items generated using this Work Template. This property value will be `null`."
        },
        "EstimatedTime": {
          "type": "string",
          "description": "The estimated time required to complete the Work Items generated using this Work Template. This property value will be `null`."
        },
        "DraftHasChanges": {
          "type": "boolean",
          "description": "This property is set to true, if the Work Template has unpublished changes"
        },
        "PublishedDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date at which this Work Template was published"
        },
        "NumberOfWorkItemsCreated": {
          "type": "number",
          "format": "int32",
          "description": "The number of Work Items created using this Work Template"
        },
        "DateLastWorkItemCreated": {
          "type": "string",
          "format": "date-time",
          "description": "The most recent date at which a Work Item was created using this Work Template"
        },
        "DateModified": {
          "type": "string",
          "format": "date-time",
          "description": "The most recent date at which this Work Template was modified"
        },
        "ActorRoles": {
          "type": "array",
          "description": "The user roles who are required to action the Work Items created using this Work Template",
          "items": {
            "type": "object",
            "properties": {
              "ActorKey": {
                "type": "string",
                "description": "A Karbon-generated unique identifier for the user role"
              },
              "ActorName": {
                "type": "string",
                "description": "The name of the user role"
              }
            }
          }
        }
      }
    }
  }
}

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-templates"
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.