The endpoint reference
Back to the guide
The complete, authoritative specification is served by the application:
GET /api/v1/openapi.json
OpenAPI 3.1. Load it into Postman, Insomnia, Swagger UI, or a client generator for your language.
Why it is not written out here
The specification lives next to the routes it describes and changes in the same commit they do. Copying it into a page by hand would create a second version that drifts from the first, and the copy would always be the one people read.
So this page points at the source rather than duplicating it.
What it covers
/me |
Who the key or connection is |
/objects |
Objects and their attributes |
/records |
List, read, create, update; notes on a record |
/lists |
Lists, and their entries |
/tasks |
List, read, create, update |
Reading it alongside this guide
The specification tells you the shape of each call. It does not explain the two behaviours most likely to surprise you:
- A scope permits an action; what you can see is a separate check. Both must pass
- Anything outside your reach returns 404, not 403
Both are covered in Authentication and scopes, and are worth reading before building against the specification.
Each endpoint in the document names the scope it requires, so you can work out what a key needs before creating it.