Developers

The Chaudie API

Version 1

Read and change your CRM's records from another tool: Zapier, your website, or your own code. Every change goes through the same rules as a change made in Chaudie, and shows in the record's Field history with the key that made it.

The short version

  • Make a key in your CRM: Company Studio, API Keys.
  • Send it with every request: Authorization: Bearer chd_…
  • Base address: https://app.chaudie.com/api/v1
  • Records are JSON, their fields named as GET /modules lists them.

Keys

An admin makes a key in Company Studio, API Keys, and names it for what will use it. A key either reads records, or reads and changes them. It is shown once: Chaudie keeps only a fingerprint of it, so it can't be shown again. Revoking a key stops it at once.

Keep keys out of web pages and apps that other people download: anyone with a key can reach your records. To take answers from your website, use Website Forms instead.

Check a key

GET /api/v1/me answers with the key's name, whether it can change records, and the CRM it belongs to.

Modules and fields

Start here: every module, its stages, and its fields with their names and types.

curl https://app.chaudie.com/api/v1/modules \
  -H "Authorization: Bearer chd_your_key"
{
  "data": [
    {
      "api_name": "lead",
      "label": "Lead",
      "label_plural": "Leads",
      "stages": ["New", "Contacted", "Won"],
      "fields": [
        { "api_name": "full_name", "label": "Full name", "type": "text", "required": true },
        { "api_name": "email", "label": "Email", "type": "email", "required": false },
        { "api_name": "source", "label": "Source", "type": "picklist", "required": false,
          "options": ["Website", "Referral"] }
      ]
    }
  ]
}

Records

List

Newest first, 50 at a time (up to 200 with limit). order=oldest reverses it. updated_since returns only records changed since a time. Any field name filters on it, ignoring case: ?email=jo@example.com. When there are more, follow next_cursor with ?cursor=….

curl "https://app.chaudie.com/api/v1/modules/lead/records?limit=2&updated_since=2026-10-01T00:00:00Z" \
  -H "Authorization: Bearer chd_your_key"
{
  "data": [
    {
      "id": "5d1c0e0a-7f3b-4c2e-9a41-1b2c3d4e5f60",
      "module": "lead",
      "stage": "New",
      "created_at": "2026-10-19T15:04:05.000Z",
      "updated_at": "2026-10-19T15:04:05.000Z",
      "fields": { "full_name": "Jo Lee", "email": "jo@example.com", "source": "Website" }
    }
  ],
  "next_cursor": "eyJ0IjoiMjAyNi0xMC0xOVQxNTowNDowNS4wMDBaIiwiaWQiOiI1ZDFjMGUwYS4uLiJ9"
}

Get one

curl https://app.chaudie.com/api/v1/modules/lead/records/5d1c0e0a-7f3b-4c2e-9a41-1b2c3d4e5f60 \
  -H "Authorization: Bearer chd_your_key"

Create

Send the fields to set, and optionally a stage. A new record starts in the module's first stage when none is given. Answers 201 with the record.

curl -X POST https://app.chaudie.com/api/v1/modules/lead/records \
  -H "Authorization: Bearer chd_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "fields": { "full_name": "Jo Lee", "email": "jo@example.com" } }'

Create or update (upsert)

Matched on a field you name, ignoring case: the record holding the same value is updated, otherwise one is created. The answer says which, with "created". This is the one to use when the same person may arrive twice.

curl -X POST "https://app.chaudie.com/api/v1/modules/lead/records/upsert?match=email" \
  -H "Authorization: Bearer chd_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "fields": { "email": "jo@example.com", "source": "Referral" } }'

Change

Only the fields you send change; the rest stay as they are.

curl -X PATCH https://app.chaudie.com/api/v1/modules/lead/records/5d1c0e0a-7f3b-4c2e-9a41-1b2c3d4e5f60 \
  -H "Authorization: Bearer chd_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "stage": "Contacted", "fields": { "source": "Referral" } }'

Delete

curl -X DELETE https://app.chaudie.com/api/v1/modules/lead/records/5d1c0e0a-7f3b-4c2e-9a41-1b2c3d4e5f60 \
  -H "Authorization: Bearer chd_your_key"

Answers 204 with nothing.

Subscriptions: hear about changes as they happen

Instead of asking again and again, subscribe: Chaudie posts each change to your https address as it happens. This is how Zapier's instant triggers work. Any key can subscribe.

curl -X POST https://app.chaudie.com/api/v1/subscriptions \
  -H "Authorization: Bearer chd_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "module": "lead", "event": "created", "target_url": "https://example.com/hooks/new-lead" }'

The event is created, updated or deleted. Each change is posted as JSON, with an X-Chaudie-Delivery header that stays the same if the same change is ever sent again:

{
  "event": "record.updated",
  "subscription_id": "9b2f…",
  "occurred_at": "2026-10-19T15:04:05.000Z",
  "changed": ["stage"],
  "record": { "id": "5d1c…", "module": "lead", "stage": "Contacted", "fields": { … } }
}
  • GET /api/v1/subscriptions lists the key's subscriptions; DELETE /api/v1/subscriptions/{id} ends one.
  • Answering 410 ends the subscription. So do 20 failed deliveries in a row, and revoking the key.
  • Up to 100 subscriptions per key.

The rules a change follows

  • Each value is checked against its field's type, and required fields must be filled.
  • The module's validation rules apply, exactly as when someone saves in Chaudie.
  • Calculated fields, and those Chaudie keeps itself like Created at, can be read but not written.
  • Automations run on changes made through the API, as on any other change.
  • Each change shows in the record's Field history, credited to the key by name.

Errors

Every error is JSON with an error sentence, and for a refused save, problems by field:

{
  "error": "The record wasn't saved: some values don't fit.",
  "problems": [{ "field": "full_name", "message": "Full name is required." }]
}
  • 400 a request that can't be read: JSON that isn't valid, an unknown filter, a limit out of range
  • 401 no key, or a key that isn't valid or was revoked
  • 402 the CRM is not on a plan now; the key works again once it is
  • 403 a read-only key trying to change something
  • 404 no such module or record
  • 422 values that don't fit the module's fields or rules
  • 429 more than 120 requests a minute with one key; wait a minute