REST API

The CRM data API is under /api/v1/object (plus /comments and /folder). Record reads/writes accept either an API key (X-Api-Key: crtk_live_… with scopes like read.contacts) or the admin JWT; relations, views, import/export, comments, folders, and analytics are JWT-only. Everything is addressed by slug, and record write bodies are keyed by field slug (see Data Model).

Every endpoint below is a direct link into the interactive API reference — click it to see the full request/response schema and try the call live.

Records

• GET /object/data/{objectSlug}/lookup
• GET /object/data/{objectSlug}
• POST /object/data/{objectSlug}
• POST /object/data/{objectSlug}/search
• GET /object/data/select-options/{objectSlug}
• GET /object/data/select-options/{objectSlug}/{fieldSlug}
• GET /object/data/facets/{objectSlug}
• GET /object/data/{objectSlug}/{dataSlug}/relations/{relationSlug} — Paginated view-all of one relation on one record. The list/detail
• GET /object/data/{objectSlug}/field-options/{fieldSlug} — Predefined options for a select-family field (select, multi_select,
• GET /object/data/{objectSlug}/{dataSlug}
• PUT /object/data/{objectSlug}/{dataSlug}
• DELETE /object/data/{objectSlug}/{dataSlug}
• GET /object/data/{objectSlug}/{dataSlug}/logs
• POST /object/data/{objectSlug}/bulk-delete
• POST /object/data/{objectSlug}/bulk-assign
• POST /object/data/{objectSlug}/bulk-update
• DELETE /object/data/{objectSlug}/bulk/all
• GET /public/forms/{objectSlug}/fields
• GET /public/forms/{objectSlug}/data
• GET /public/forms/{objectSlug}/data/{recordSlug}
• POST /public/forms/{objectSlug}/submit

Objects

• POST /object/migrate/all — Trigger clean migration for ALL objects (drops tables and re-migrates)
• POST /object/migrate/{objectSlug} — Migrate a single object by slug
• GET /object/migrate/status — Get migration status for all objects

Fields

• POST /object/field/placement/{fieldSlug} — Attach a shared field to one or more objects
• GET /object/field/placement/{fieldSlug} — Get all placements for a field (all objects where it's shared)
• DELETE /object/field/placement/{objectSlug}/{fieldSlug} — Remove a shared field placement from an object
• GET /object/field/types
• GET /object/field/tags
• GET /object/field/{objectSlug}
• POST /object/field/{objectSlug}
• GET /object/field/all/{objectSlug}
• GET /object/field/active/{objectSlug}
• GET /object/field/select/{objectSlug}
• GET /object/field/trigger-fields/{objectSlug}
• GET /object/field/show/{objectSlug}/{fieldSlug}
• POST /object/field/duplicate/{objectSlug}
• PUT /object/field/{objectSlug}/order
• PUT /object/field/{objectSlug}/{fieldSlug}
• DELETE /object/field/{objectSlug}/{fieldSlug}
• PUT /object/field/toggle-status/{objectSlug}/{fieldSlug}
• POST /object/data/{objectSlug}/smart-catalog/{fieldSlug}/browse — Browse source records for a Smart Catalog field.

Relations

• POST /object/relation
• GET /object/relation/{objectSlug}
• GET /object/relation/active/{objectSlug}
• PUT /object/relation/{slug}
• PUT /object/relation/toggle-status/{slug}
• PUT /object/relation/{slug}/status

Views

• POST /object/custom/view/{objectSlug}
• GET /object/custom/view/{objectSlug}
• GET /object/custom/view/details/{objectSlug}/{slug}
• PUT /object/custom/view/{objectSlug}/order
• PUT /object/custom/view/{objectSlug}/{slug}/default
• PUT /object/custom/view/{objectSlug}/{slug}
• DELETE /object/custom/view/{objectSlug}/{slug}
• GET /object/custom/view/{objectSlug}/kanban/{slug} — Get Kanban board data for a custom view
• GET /object/data-table-config/{objectSlug}
• PUT /object/data-table-config/{objectSlug}
• DELETE /object/data-table-config/{objectSlug}

Export Import

• POST /object/data/{objectSlug}/export
• GET /object/data/{objectSlug}/export/status/{jobSlug}
• GET /object/data/{objectSlug}/export/download/{jobSlug}
• POST /object/data/{objectSlug}/import/preview
• POST /object/data/{objectSlug}/import/upload/init
• POST /object/data/{objectSlug}/import/upload/{uploadId}
• GET /object/data/{objectSlug}/import/preview/{jobSlug}/status
• GET /object/data/{objectSlug}/import/preview/{jobSlug}/rows
• POST /object/data/{objectSlug}/import/execute
• GET /object/data/{objectSlug}/import/status/{jobSlug}
• GET /object/data/{objectSlug}/import/{jobSlug}/failed-rows
• GET /object/data/{objectSlug}/import/template

Comments

• GET /comments/{objectSlug}/{dataSlug}
• POST /comments/{objectSlug}/{dataSlug}
• PUT /comments/{objectSlug}/{dataSlug}/{id}
• DELETE /comments/{objectSlug}/{dataSlug}/{id}
• GET /comments/{objectSlug}/{dataSlug}/{id}/replies
• POST /comments/{objectSlug}/{dataSlug}/{id}/reply
• POST /comments/{objectSlug}/{dataSlug}/{id}/react

Record Move

• POST /object/data/move/{objectSlug}/preview
• POST /object/data/move/{objectSlug}/execute
• POST /object/data/move/{objectSlug}/bulk-execute
• POST /object/data/move/{objectSlug}/reverse/{recordSlug}
• GET /object/data/move/{objectSlug}/history/{recordSlug}
• GET /object/data/move/{objectSlug}/journey/{globalRecordSlug}

Folders

• GET /folder
• POST /folder
• PUT /folder/order
• DELETE /folder/objects/{objectSlug}
• PUT /folder/{slug}
• DELETE /folder/{slug}
• PUT /folder/{slug}/objects

Analytics

• GET /object/{objectSlug}/analytics/status-counts
• GET /object/{objectSlug}/analytics/activity-timeline

Next

Frontend Integration · Examples · Data Model