Getting started with the API

Back to the guide

Deeluge has a REST API at /api/v1 for reading and updating CRM data from your own software.

Get a key

An owner or admin creates one under Settings → API keys. It looks like sf_live_… and is shown once.

See API keys for what a key can be given.

Make a request

Send the key as a bearer token:

Authorization: Bearer sf_live_…

Everything lives under /api/v1. For example, who the key is:

GET /api/v1/me

What is available


Objects	List objects and their attributes
Records	List, read, create and update records; add notes
Lists	List them, and read, add and update their entries
Tasks	List, read, create and update

Deliberately not available: team and invitations, access grants, API key management, billing, email accounts and message bodies, admin, cron and webhooks.

The full reference

The complete specification is served by the application itself:

GET /api/v1/openapi.json

It is OpenAPI 3.1, so it loads straight into Postman, Insomnia, Swagger UI or a client generator. It is maintained alongside the routes rather than written separately, which is why it is the authoritative description of the API.

Three things to know before you build

Your key sees less than you do. Scopes say what a key may do; record permissions say what it can see. Both are checked. A restricted record stays invisible until somebody grants that key access, and it comes back as not found rather than forbidden.

Lists are cursor-paged, not page-numbered. Follow next_cursor.