REST API quickstart: create your first lead

8 min read

Authenticate with a Bearer key and create a lead.

The external API covers leads and support tickets, read them and create them. JSON over HTTPS, base URL https://api.cadey.ai.

Get a key

In Settings → API keys, create a key. It is shown once and stored hashed. Keys carry scopes: read for GET, write for POST.

Create a lead

curl https://api.cadey.ai/v1/api/leads \
  -H "Authorization: Bearer cady_live_…" \
  -H "Content-Type: application/json" \
  -d '{"email":"jane@acme.com","name":"Jane Doe","company":"Acme"}'

The lead upserts on (workspace, email), so re-sending the same email updates rather than duplicates. A first-time create fires the lead.created webhook.

Next

List with GET /v1/api/leads, fetch one with /v1/api/leads/{id}, and do the same for /v1/api/tickets. A rolling 24-hour request cap applies per workspace. See the full reference at /docs.