Headless CRM

Use CRM data in your own app

Build a custom interface or connect a service to your CRM through the API. Manage contacts, deals, and tasks from your code, with an included dashboard for your team.

Create a workspace Connect an agent

What Headless CRM means

The term explained, followed by how it works in Agent Native CRM.

What headless means

A headless CRM makes its features available through an API, so your software can use the data without going through the product’s screens.

An optional interface is included

Agent Native CRM includes a dashboard for records, deals, and tasks. Your team can use it while your application works with the same data through the API.

What to check before you choose

For Headless CRM, check these details before connecting your team or software.

Interface

Question to askMust my team use the built-in screens?

Agent Native CRMUse the included dashboard, build your own interface, or use both with the same workspace.

Data structure

Question to askCan the app discover custom fields?

Agent Native CRMThe workspace settings API lists record types and fields, including the ones your team added.

Record lists

Question to askCan I control which records a screen shows?

Agent Native CRMSaved views define filters, sorting, columns, and grouping for record lists.

Changes

Question to askHow can my service detect updates?

Agent Native CRMRead recent activity using filters and a timestamp. Outbound webhooks are not available today.

What you can do

Here are the actions you can take, followed by the API requests a developer or agent can use for each one.

Choose the requests your app needs

The API reference documents the available operations. Start with the records, tasks, and deals your app will display or update.

GET /v1/openapi.json
GET /v1/skill

Read the workspace structure

Look up record types and fields before building forms. Authorized clients can add custom types or change field settings.

GET /v1/schema
POST /v1/schema/objects
PATCH /v1/schema/fields/{id}

Use saved lists in your interface

Define a view once, then fetch its matching records. Your app and team can use the same filters and sort order.

POST /v1/views
GET /v1/views/{id}/records
GET /v1/views

Manage access separately

Give each client or agent its own identity and keys. Revoke a key when that connection should no longer access the workspace.

POST /v1/principals
POST /v1/principals/{id}/keys
DELETE /v1/principals/{id}/keys/{key_id}

Agent Native CRM

Your interface and your team can use the same CRM records.

How you stay in control

Choose who can change data, review important work, and correct mistakes. Some checks are built in; optional policies need to be configured.

Choose what people see

Build the screens your users need, or use the existing dashboard to check records and tasks without building another interface.

Respect workspace permissions

A custom app receives only the access allowed by its key’s role. Using your own interface does not bypass those permissions.

Keep your reads manageable

Fetch records in pages and continue with the returned cursor. This keeps large lists practical to load in your application.

Read the change history

Check activity records to see when your app or an agent changed something. Earlier activity remains available after later updates.

GET/v1/openapi.json

Connection and response details

These notes explain the fields or connection settings used in this example. The setup guide includes the complete request and response formats.

Read the setup guide

GET /v1/openapi.json

openapi: The version of the OpenAPI document format.
paths: The URL paths available for CRM requests.
operations: The supported actions and their request fields.
securitySchemes: How to send a bearer access key with a request.
errors: Response formats for failed requests.

What you provide

Use the CRM for records and tasks, and connect the other tools your workflow needs.

Run your application elsewhere

Host your custom interface and server in your own environment. This CRM provides the data service rather than hosting your app.

Use a separate sender

The CRM does not send email or social messages. Your application needs its own sending tool and should save the result afterward.

Check for updates through the API

There are no outbound webhooks today. Your service can periodically read activity after the last timestamp it processed.

Common questions

Practical answers about setup, capabilities, and what you need to provide.

What is a headless CRM?

It is a CRM whose features are available through an API. You can work with contacts and deals from your own application without automating its screens.

Does this one include a dashboard?

Yes. The dashboard is available for your team to manage records and review work while your software uses the same workspace through the API.

Can I add fields for my application?

Yes. An authorized user or agent can add custom fields and record types, which your application can then read and update.

How will my application learn about changes?

Read activity records filtered by time or event type. You need to make those requests yourself because outbound webhooks are not currently available.

Related guides

Learn more about the connection options and examples that fit your work.

Start with your first contact

Create a workspace, connect your agent, and add your first contact. Choose a plan based on how many records and activity entries you need to store.

Create a workspace See pricing