Kantos

The Objects API lets you manage your CRM schema programmatically. List available objects, inspect their schemas, and create new object definitions.

List Objects

GET /api/crm/objects

# Response
{
  "data": [
    {
      "id": "obj_contacts",
      "name": "Contacts",
      "slug": "contacts",
      "icon": "user",
      "field_count": 12
    },
    {
      "id": "obj_companies",
      "name": "Companies",
      "slug": "companies",
      "icon": "building",
      "field_count": 8
    }
  ]
}

Get Object Schema

Retrieve the full schema for an object, including all field definitions:

GET /api/crm/objects/{object_id}

# Response includes all fields
{
  "id": "obj_contacts",
  "name": "Contacts",
  "slug": "contacts",
  "fields": [
    {
      "id": "fld_name",
      "name": "Name",
      "slug": "name",
      "type": "text",
      "required": true
    },
    {
      "id": "fld_email",
      "name": "Email",
      "slug": "email",
      "type": "email",
      "required": true,
      "unique": true
    }
  ]
}

Create Object

Create a new object definition with an initial set of fields:

POST /api/crm/objects
Content-Type: application/json

{
  "name": "Projects",
  "icon": "folder",
  "fields": [
    {
      "name": "Project Name",
      "type": "text",
      "required": true
    },
    {
      "name": "Status",
      "type": "status",
      "options": {
        "stages": ["Planning", "In Progress", "Review", "Complete"]
      }
    },
    {
      "name": "Budget",
      "type": "currency"
    }
  ]
}

Schema Management

Object and field definitions are admin-only operations. Your API key must belong to a user with admin privileges to create or modify schema. See Custom Objects for more on schema design.

Next Steps

Fields API — Manage fields on existing objects
Records API — Work with record data
Data Model Guide — Learn about schema design