API Reference

FairCRM API.

REST API. Auth with a Bearer token.

Base URL

https://api.faircompany.ai/v1/crm

Authentication

All requests use a Bearer token. Get one from faircrm.ai/app.

Authorization: Bearer fair_live_...

Endpoints

POST/v1/crm/contacts

Create a new contact.

{
  "input": "...",
  "metadata": { "ref": "your-internal-id" }
}

Returns the resource:

{
  "id": "contact_01HX...",
	  "status": "queued"
}

GET/v1/crm/contacts/:id

Fetch a contact by ID. Returns full state.

GET/v1/crm/contacts

List contacts. Supports cursor pagination, created_after, status, and metadata filters.

DELETE/v1/crm/contacts/:id

Cancel a queued contact.

POST/v1/crm/webhooks

Register a webhook for contact.created, contact.completed, contact.failed events. Signed with HMAC-SHA256.

Errors

  • 401 Unauthorized — missing or invalid Bearer token.
  • 422 Unprocessable — input failed validation.
  • 429 Rate Limit — exponential backoff with the Retry-After header.