API overview
The Kushi public API lets your website, landing pages, and other systems push records — leads or orders — straight into a collection in your workspace, and read a collection's schema so you can build matching forms.
It's a small, focused REST API (not GraphQL), designed to drop into a landing page or checkout with a few lines of code.
Base URL
https://crm.api.kushicorp.com
All public endpoints live under the /public/v1 prefix.
Endpoints at a glance
| Method | Path | Purpose |
|---|---|---|
POST |
/public/v1/collections/{collectionId}/records |
Create a record (lead / order) |
PATCH |
/public/v1/records/{recordId} |
Update a record's status and/or fields |
GET |
/public/v1/collections/{collectionId}/schema |
Read a collection's field schema |
Conventions
- Auth — every request needs an API key. See Authentication.
- Content type — send
Content-Type: application/json; request and response bodies are JSON. - IDs —
collectionIdandrecordIdare UUIDs. Find a collection's ID (and copy-paste snippets) on its Integrate tab in the app. - Availability — the API is included on every plan. Order creation still counts toward your plan's monthly order limit.
Errors
Errors return a JSON body { "error": "message" } with a standard status code:
| Status | Meaning |
|---|---|
400 |
Malformed body (e.g. not a JSON object) |
401 |
Missing or invalid API key |
404 |
Collection or record not found (or not in your workspace) |
500 |
Something went wrong on our side |