Skip to content

REST API

The API lets other systems (your shop, Zapier or Make, your scripts) read and change records of your collections. It uses JSON at https://<your app>/api/v1. Each key is a service account with its role, its collections and actions, and an optional expiry.

  1. Go to Settings → API (Configuración → API) and create a key: name, role (a company role or a custom one), collections and actions, and expiry (30, 90, 180 or 365 days, or none).
  2. Copy the hska_… token: it is shown only once.
  3. Call with Authorization: Bearer hska_…:
    • GET /collections
    • GET /collections/{key}/records (cursor, filters, sort and updatedSince)
    • GET /collections/{key}/records/{id}
    • POST /collections/{key}/records (one or a batch of up to 50)
    • PATCH /collections/{key}/records/{id} (optional If-Match)
    • DELETE /collections/{key}/records/{id} (to the trash)
  4. Rotate the key (the old token can keep working for 1 or 24 hours) or revoke it.
  • Servers only: a request from a browser gets 403 cors_not_allowed.
  • 120 calls per minute per key and 600 per company; 256 KB body; pages up to 100; 10 filters per request; 100 active keys.
  • What a key writes is recorded under the key and goes through the same rules and automations as the app.
  • Managing keys requires api:manage. The company can turn the API off (403 api_disabled).
  • There are no MCP tools to create keys: they are created in the app.
  • To work with records from an agent, use MCP (list_records, create_records, search_records) instead of the API.