Skip to main content

HTTP API reference

Clients

Agency clients (projects) scoped to your organization. Required client_id on every extraction and list call.

Endpoints in this topic

GET/api/clients

List clients for the authenticated organization.

Request
GET — no query params; scoped to the API key organization.
Response
{ clients: [{ id, name, tax_id?, email?, notes?, created_at }] }

POST/api/clients

Create a client under the organization.

Request
Content-Type: application/json

{ "name": "…", "tax_id"?: "…", "email"?: "…" }
Response
201 { client: { id, name, tax_id?, email?, notes?, created_at } }

GET/api/clients/[id]

Fetch one client by id.

Request
Path [id] = client UUID.
Response
{ client: { id, name, tax_id?, email?, notes?, created_at } }