Introduction

The Code F CRM API gives your systems the same access to customer data that your team has in the app. Keep contacts and orders in sync with your shop, send behavioural events, build audiences, send email and run automations, all over a predictable REST API.

What you can build

  • Customer sync: upsert contacts, orders and any custom object using your own IDs, so re-sending the same data never creates duplicates.
  • Behavioural tracking: send events like order.placed or cart.abandoned. They land on the customer's timeline and can start automations.
  • Messaging: send transactional email, or create campaigns to a segment.
  • Integrations: receive signed webhooks when records change, emails are opened or customers enter a segment.

Base URL

All endpoints live under one versioned base URL:

HTTP
https://crm.codefab.dev/api/v1

The basics

FormatJSON requests and responses, UTF-8. Dates are ISO 8601 (2026-09-25T10:15:30Z).
AuthenticationAn API key in the X-API-Key header. See Authentication.
ErrorsRFC 9457 problem documents with a stable code. See Errors.
PaginationCursor-based: pass nextCursor back as cursor. See Pagination & filtering.
Rate limitsPer API key. See Rate limits.

Core concepts

Objects and records. Everything in the CRM is a record of some object type. Contacts, companies and orders come built in; you can add your own objects (subscriptions, stores, tickets) with their own fields. One API covers them all: /objects/{objectKey}/records.

Events. Things that happen to a record, such as a purchase, a login or a support ticket. Each event type is registered with the fields it carries, so the data stays clean.

Segments. Saved audiences defined by conditions on fields, tags, events and related records. Membership updates itself.

Automations and flows. Automations run by themselves (a trigger enrols records, which walk steps such as emails, waits and conditions). Flows are playbooks your team works records through by hand.

Copying. Email and SMS templates, segments, forms and surveys, flows, campaigns and automations each have POST /api/v1/{kind}/{id}:duplicate. The copy is named "<name> (copy)" and starts as a draft or switched off: a form copy has its own link and answers event and no answers, a flow copy has the steps and buttons but none of the records, and a campaign copy is an unsent draft.

Next: make your first request in the Quickstart, or jump into the API reference.