Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.clarky.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Clarky REST API gives you programmatic access to the same CRM data you see in the dashboard — contacts, companies, pipelines, activities, forms, and submissions. Use it to sync data into your data warehouse, build custom dashboards, automate lead capture, or power two-way integrations with your stack.
Plan availability: API access is available on the Standard, Pro, and Enterprise plans. See Plans & Billing.

​
Base URL

All endpoints are served from a single base URL: 
https://clarky.ai/api/v1
The API is versioned in the URL path. The current version is v1. We’ll announce breaking changes well in advance and maintain older versions for a documented deprecation window.

​
Conventions

  • Format — All requests and responses are JSON. Send Content-Type: application/json with POST and PATCH requests.
  • Workspace scope — Every API key belongs to a single workspace. Calls automatically operate on that workspace’s data.
  • Single resources — Returned as { "data": { ... } }.
  • List resources — Returned as { "data": [...], "pagination": { ... } }.
  • Deletes — Return 204 No Content with an empty body.
  • Errors — Wrapped in a consistent error envelope. See Errors.

​
Quick example

curl https://clarky.ai/api/v1/contacts \
  -H "Authorization: Bearer ck_live_example"

​
Get started

Quickstart

Make your first curl request in under 2 minutes

Authentication

Create an API key, understand scopes, and authenticate requests

Errors

Error envelope shape and every error code with examples

Pagination

Page through list endpoints with page and page_size

Rate Limits

Per-key request limits and recommended retry behavior

​
Resources

Contacts

Create, read, update, delete, and bulk upsert contacts

Companies

Manage companies and the contacts that belong to them

Pipelines

Read pipelines and stages, manage pipeline cards

Activities

Log notes, calls, meetings, tasks, and reminders

Forms

Read forms and their submissions

​
API and Webhooks

The REST API and Webhooks are complementary. The API is the right tool for two-way data flow — pulling data on demand, creating and updating records, or backfilling historical data. Webhooks are best for one-way, real-time push notifications when something happens inside Clarky. Most integrations use both.
Need a feature that isn’t covered yet? Email support@clarky.ai — we’re actively expanding the API surface.