Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

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

​
Base URL

All API requests go to: 
https://api.zenskar.com

​
Authentication

Every request requires two headers:
HeaderRequiredDescription
x-api-keyYesYour API key
organisationYesYour organisation ID
apiversionNoAPI version (default: 20230501)
Example: 
curl https://api.zenskar.com/customers \
  -H "x-api-key: <YOUR_API_KEY>" \
  -H "organisation: <YOUR_ORG_ID>"
To get your API key and organisation ID, go to Settings > API Keys in the Zenskar dashboard.

Manage API Keys

Create, view, and revoke API keys from the dashboard.

​
API Versioning

The default API version is 20230501. To pin to a specific version, pass it in the apiversion header: 
-H "apiversion: 20230501"

​
Request Format

  • All request bodies are JSON. Set Content-Type: application/json.
  • All responses are JSON.

​
Errors

Zenskar uses standard HTTP status codes.
StatusMeaning
200Success
400Bad request. Check your request body or parameters.
401Unauthorised. Missing or invalid x-api-key / organisation.
404Not found
422Validation error. The request body failed schema validation.
500Server error
Validation errors (422) return a body describing which fields failed: 
{
  "detail": [
    {
      "loc": ["body", "field_name"],
      "msg": "field required",
      "type": "value_error.missing"
    }
  ]
}

​
Pagination

List endpoints support cursor-based pagination via limit and offset query parameters: 
GET /customers?limit=20&offset=0

​
Key Resources

Customers

Create and manage customer records

Contracts

Create contracts, manage phases and pricing

Invoices

Generate, approve, and void invoices

Payments

Record and retrieve payments

Usage Events

Ingest metered usage data

Billable Metrics

Define aggregates over usage events

Plans

Define reusable pricing plans

Products

Manage products and their pricing

Quotes

Create and accept quotes

Accounting

Journal entries and revenue recognition