Quickstart

Create a tokenCopy Anchor Link

In Helvetly, open Settings → API & MCP and choose Create token. Give it a name you will recognise later (for example the script or tool that uses it), pick what it may access and, optionally, when it expires.

Copy the token now: it starts with hvt_ and is shown only once. Store it like a password, for example in your password manager or your tool's secret store.

Make a requestCopy Anchor Link

Send the token in the Authorization header. This lists the first clients of the token's workspace:

curl https://app.helvetly.com/api/v1/clients \
  -H "Authorization: Bearer hvt_…"

Read the answerCopy Anchor Link

Lists come in a data array with paging in meta:

{
  "data": [{ "id": "cli_…", "number": 1, "name": "Muster AG", "email": "billing@muster.ch" }],
  "meta": { "page": 1, "page_size": 50, "total": 1, "total_pages": 1 }
}

Create somethingCopy Anchor Link

A token with write access can create records. This creates a draft invoice, which you can review in the app before you issue it:

curl https://app.helvetly.com/api/v1/invoices \
  -H "Authorization: Bearer hvt_…" \
  -H "Content-Type: application/json" \
  -d '{"client_id": "cli_…", "lines": [{"description": "Consulting", "quantity": "2", "unit_price": "150.00"}]}'