Skip to content
Docs

Getting started with the API

Create a personal access token and make your first authenticated /api/v1 request.
Developer6 min read

ChatinFlow Team

Official guide

Overview

Use a personal access token (PAT) to call ChatinFlow from scripts, middleware, or your own backend. Browser apps signed into the dashboard use Sanctum session cookies instead.

By the end of this guide you will have a PAT, a successful authenticated request, and a clear path to list or mutate workspace resources.

Before you start

Verified ChatinFlow account

Email verification required

Workspace membership

Tokens belong to you and act with your role

Plan with API access if gated

Check Settings β†’ Billing entitlements

First API call

01

Create a personal access token

Open Dashboard β†’ Settings β†’ Developers. Name the token, generate it, and copy the secret once. Store it outside ChatinFlow.

Settings β†’ DevelopersCopy once
02

Call a versioned endpoint

Send the token as a Bearer Authorization header against `/api/v1/...`. Include Accept: application/json. Every response carries X-Request-Id for support.

curl -sS https://api.chatinflow.com/api/v1/workspaces \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Accept: application/json"
Authorization: BearerX-Request-Id
03

Mutate safely

Send an Idempotency-Key (UUIDv4) with POST, PUT, PATCH and DELETE. It is optional but recommended: a retry with the same key returns the first answer instead of writing twice, for 24 hours.

curl -sS -X POST https://api.chatinflow.com/api/v1/... \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Idempotency-Key: 550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -d '{}'
Idempotency-KeyUUIDv4

Tips

Tip

Prefer cursor pagination

List endpoints return `{ data, meta: { nextCursor, hasMore } }`. Do not expect a total count unless a dedicated include exists.

Heads up

Never log PATs

Treat tokens like passwords. Revoke compromised tokens immediately under Settings β†’ Developers.

Note

Product playbooks

For Automations, Inbox, and channel setup, use the Help Center, not these developer docs.

Was this guide helpful?

Browse more in the library

All docs

Ready to put this
into practice?

Start building your first automation for free. No credit card required. Just connect your channel and launch in minutes.