Karbon · Schema

CustomFieldDefinition

The structure that defines a Custom Field in Karbon

CompanyAccountingPractice ManagementWorkflowsCollaborationProfessional ServicesSoftware-as-a-Service

Properties

Name Type Description
Name string
Type string
IsVisibleToContacts boolean
IsVisibleToOrganizations boolean
ListOptions array
View JSON Schema on GitHub

JSON Schema

karbonhq-custom-field-definition-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/karbonhq/json-schema/karbonhq-custom-field-definition-schema.json",
  "title": "CustomFieldDefinition",
  "description": "The structure that defines a Custom Field in Karbon",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/karbonhq-custom-fields-api-openapi.yml#/components/schemas/CustomFieldDefinition",
  "type": "object",
  "properties": {
    "Name": {
      "type": "string",
      "maxLength": 100
    },
    "Type": {
      "type": "string",
      "enum": [
        "Text",
        "Number",
        "Date",
        "Boolean",
        "Colleague",
        "ListSingleSelect",
        "ListMultipleSelect"
      ]
    },
    "IsVisibleToContacts": {
      "type": "boolean"
    },
    "IsVisibleToOrganizations": {
      "type": "boolean"
    },
    "ListOptions": {
      "descriptions": "A value or values assigned to the Custom Field, note that all values for all types are strings - this includes `number` and `boolean` types",
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 256
      }
    }
  }
}

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-custom-field-definition"
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.