Client OS API
API reference
apps/api is a Hono app whose routes are OpenAPI 3.1 definitions. The web app uses it through a generated client. One page per area, with every operation.
Methods and paths come from packages/api-client/openapi.json, which CI regenerates from the route definitions; this site builds its lists from that file. Every /api operation needs a Supabase Auth JWT or a PAT and is rate limited. /health and /health/deep are plain routes outside the spec.
- Caller and members3 operations
Who is calling, the members of your organizations, and changing an Org member’s Role.
- Service accounts3 operations
Non-human callers that belong to one Organization and authenticate with a PAT.
- Organizations3 operations
The organizations you belong to, and each one’s SSO configuration.
- Clients5 operations
The Client records of the clientos example: the anchor most records hang off.
- Contacts5 operations
People on the Client side; one can be the primary contact.
- Companies and communication log10 operations
Businesses connected to a Client, and the log of calls, emails and meetings.
- Projects, milestones and decisions15 operations
Bodies of work for a Client, with their milestones and recorded decisions.
- Tasks5 operations
Work items for a Client or Project.
- Promises5 operations
Explicit commitments made to a Client, with due dates.
- Notes5 operations
Freeform Note records for a Client or Project.
- Contracts, invoices and time25 operations
Contracts, invoices, retainers, support plans and time entries.
- Infrastructure25 operations
Servers, domains, cloud accounts, deployments and branches.
- Technology33 operations
Technologies and the projects that use them, dependencies, risks, ideas and tech debt.
- Meetings8 operations
Meetings and who attended them.
- Assets and repositories10 operations
A Client’s assets and code repositories.
- Environments, links and credential references15 operations
Environments, saved links, and references to where credentials live.
- Documents and LLM context15 operations
Documents, local folders and the Context files that make up a Client’s LLM context.