REST API
Read-and-write access to the canonical SMB-operations graph. Every connected tool — and every external caller — speaks the same shape through these API routes.
OpenAPI 3.1 spec download, interactive try-it console, and per-language SDK packages ship with the developer-portal launch. This page is the orientation reference.
Base URL
https://api.adaptlive.app/v1Authentication
Two methods. Choose based on whether the caller is a human (OAuth) or a server (PAT).
- OAuth 2.0 (Authorization Code + PKCE) — for apps acting on behalf of an adaptlive user. Scopes are per-domain (e.g.
parties.read,work.write). - Personal Access Tokens — for server-to-server integrations. Issued from the organization Settings page; carry organization-wide scopes; never expire unless revoked.
Authorization: Bearer <token>
X-adaptlive-Organization: org_01HX...Resource API routes
Every canonical entity has the same five-verb surface: GET /list, GET /:id, POST, PATCH /:id, DELETE /:id.
| Entity | Path |
|---|---|
| Party | /v1/parties |
| Location | /v1/locations |
| ContactMethod | /v1/contact-methods |
| WorkRecord | /v1/work-records |
| MoneyRecord | /v1/money-records |
| Conversation | /v1/conversations |
Idempotency
Every POST and PATCH accepts an Idempotency-Key header. Replays with the same key within 24 hours return the original response — safe to retry from any network layer.
POST /v1/work-records
Idempotency-Key: 1f2e3d4c-...
Content-Type: application/json
{
"workType": "service_job",
"title": "Emergency water leak",
"partyId": "pty_01HX..."
}Webhooks
Subscribe to canonical events at the organization or workspace level. Every payload is signed with X-adaptlive-Signature (HMAC-SHA256). Delivery has at-least-once semantics — your handler should be idempotent on event.id.
party.created,party.updatedwork_record.created,work_record.stage_changed,work_record.completedmoney_record.created,money_record.paidconversation.completed(call hangup, SMS thread close, email thread close)
Rate limits
Per-organization: 600 req/min sustained, burst to 1,200/min for 10 seconds. Per-token: 240 req/min. Limits return 429 Too Many Requests with Retry-After in seconds.
Server-side adapter callers running under our marketplace get uplifted limits and a separate fair-use envelope — see the adapter contract docs.
Next
- Canonical schema reference — the entities these API routes operate on.
- Adapter contract — building an adapter against the same schema rather than calling the REST API directly.
- Work with us — apply to the partner program for marketplace listing.