API overview
What the klerc API covers, how requests and responses look, and where the full reference lives.
The klerc API gives your code the same reach as the console: records, queries, flows, the inbox, tasks, workflows, agents and more. It's a token-authenticated REST API that speaks JSON.
One action registry powers the console, Molly and the API. When you call the API you use the same operations the product uses, under the same permissions.
Base URL and spec#
| Item | Value |
|---|---|
| Base URL | https://api.klerc.co/api/v1 |
| Format | JSON in, JSON out |
| Authentication | Authorization: Bearer wk_live_… — see Authentication |
| OpenAPI spec | https://api.klerc.co/api/v1/openapi.json (OpenAPI 3.1) |
The API reference is generated from that spec and lists every endpoint with its method, path, parameters, request body and required scope.
What you can do#
| Area | Highlights |
|---|---|
| Objects and records | Object schemas; create, read, update, delete and bulk-create records |
| Query | SOQL, SOSL, SAQL or plain English through one endpoint |
| Flows | Add records to pipelines and move them between stages |
| Lists | Dynamic and frozen segments, refresh and freeze |
| Tasks and notes | Create and update work items |
| Inbox and team inbox | Conversations and messages, customer-facing and internal |
| Reports and dashboards | Saved reports, dashboards, pinning |
| Calendars, forms, chatbots, workflows | Events, submissions, sessions, runs and test runs |
| Agents and secrets | Configure agents, wake them, decide approvals |
| Knowledge | Files, folders, versions and sharing |
| Integrations and audit logs | Connected apps and the audit trail |
Requests and responses#
Successful responses share one envelope:
{ "status": 200, "data": { }, "message": "OK"}data holds the result. Errors use a companion envelope with a machine-readable code — see Errors and limits.
List endpoints are paged. Pass limit for page size, and pass the cursor the previous page returned as cursor to get the next one.
Scopes#
Every operation declares the scope it needs, such as objects:view to read records or objects:use to write them. Operations that change data are marked as writes in the reference. See Authentication for the full list.
Your first call#
curl "https://api.klerc.co/api/v1/tasks?limit=10" \ -H "Authorization: Bearer $KLERC_TOKEN"Then try Querying and Working with records.