Developers
CraftifyAI Developer API
The CraftifyAI Public API lets you manage contacts and interaction logs in your CRM, and subscribe to outbound webhooks so your systems react in real time to new contacts, updates, interaction logs, and web form submissions.
The API is organized around two capabilities. First, a REST interface for reading and writing contacts, recording interaction logs on a contact timeline, and discovering the reference data (contact types, interaction types, custom fields, tags) your project is configured with. Second, outbound webhooks that push events to your endpoint so you do not have to poll.
Who it is for
This API is for developers integrating CraftifyAI with booking systems, internal tools, data warehouses, or any service that needs to keep contact data in sync. Every request is authenticated with a project-scoped API key, so a key can only ever touch the data in the one project it belongs to.
Base URLs
All endpoints are versioned under /v1. Use the production base URL for live data and the development base URL for testing.
| Environment | Base URL |
|---|---|
| Production | https://api.craftify.ai/v1 |
| Development / sandbox | https://dev-api.craftify.ai/v1 |
What you can do
| Endpoint | Purpose |
|---|---|
GET /ping | Verify a key and see its project and scopes. |
GET /contacts | List and search contacts with filters and cursor pagination. |
POST /contacts | Create a contact (create-only, never upsert). |
GET /contacts/{contactId} | Retrieve a contact, including its duplicate signal. |
PATCH /contacts/{contactId} | Partially update a contact. |
POST /contacts/{contactId}/interactions | Add an interaction log to a contact timeline. |
GET /contacts/{contactId}/interactions | List a contact interaction logs. |
GET /contact-types, /interaction-types, /custom-fields, /tags | Discover reference ids for your project. |
GET/POST/PATCH/DELETE /webhooks | Manage outbound webhook subscriptions. |
Next steps
- Getting started — go from zero to your first contact in six steps.
- Authentication — API key format, headers, and scopes.
- Contacts — the contact model, create, update, and search.
- Interaction logs — record events on a contact timeline.
- Webhooks — subscribe to events and verify signatures.
- API reference — the full interactive endpoint reference.
New to the API? Create a key under Settings, then follow the Getting started quickstart.