New · Tafkiro AI v2 ships predictive cash-flow forecastingRead the release →
Developers

API Documentation

REST API for reading and writing Tafkiro data. Authentication, filters, pagination, and webhooks.

01 Authentication

API keys and tokens

The Tafkiro API uses token-based authentication. Generate an API Key and API Secret from your user profile under Settings → API Access. Pass them as HTTP Basic Auth credentials: username is the API Key, password is the API Secret.

curl https://your-tenant.tafkiro.app/api/resource/Sales%20Invoice \
  -u "your_api_key:your_api_secret"
02 Core endpoints

Resource endpoints

GET
/api/resource/{doctype}List records of a given doctype with filters and pagination.
GET
/api/resource/{doctype}/{name}Retrieve a single document by name.
POST
/api/resource/{doctype}Create a new document.
PUT
/api/resource/{doctype}/{name}Update an existing document.
DELETE
/api/resource/{doctype}/{name}Delete a document (where permitted).
POST
/api/method/{method}Call a server-side method by dotted path.
03 Webhooks

Real-time event delivery

Configure webhooks from Settings → Webhooks to receive POST events when documents are created, updated, or submitted. Events are delivered with retry logic (3 attempts, exponential backoff). Payload is JSON with the full document fields.

Developer support