Skip to content

Endpoint reference

Every route, and the scope it needs. This table is generated from the routes the API actually serves, so it cannot describe an endpoint that does not exist or omit one that does.

EndpointScope requiredFilters
GET /api/v1/assets
GET /api/v1/assets/{id}
assets:readcategory, location_id, status
GET /api/v1/handovers
GET /api/v1/handovers/{id}
handovers:readlocation_id, status
GET /api/v1/learning-assignments
GET /api/v1/learning-assignments/{id}
learning:read
GET /api/v1/locations
GET /api/v1/locations/{id}
locations:read
GET /api/v1/people
GET /api/v1/people/{id}
people:readlocation_id
GET /api/v1/purchase-requests
GET /api/v1/purchase-requests/{id}
approvals:readlocation_id
GET /api/v1/systems
GET /api/v1/systems/{id}
systems:readcategory, location_id, status
GET /api/v1/tasks
GET /api/v1/tasks/{id}
tasks:readlocation_id
GET /api/v1/transitions
GET /api/v1/transitions/{id}
transitions:readlocation_id, status
GET /api/v1/vendors
GET /api/v1/vendors/{id}
vendors:readcategory, location_id, status
GET /api/v1/workplace-records
GET /api/v1/workplace-records/{id}
workplace:readlocation_id, record_type, status

Common parameters

Every list accepts:

  • limit — 1 to 1000, default 100
  • cursor — the next_cursor from the previous page
  • updated_since — an ISO 8601 timestamp; returns only records changed after it

Where a register supports text search it also accepts search. Per-endpoint filters are in the table above; a value outside the set an endpoint accepts is a 400 rather than an empty page.

Scopes

ScopeCoversWhat it reads
vendors:readVendors & RenewalsSubscriptions, contracts, owners, spend, seats and renewal dates.
approvals:readRequests & ApprovalsPurchase requests, their approvers and the decisions taken on them.
systems:readSystems & AccessBusiness systems, their owners and who holds access to each.
learning:readLearning & CompliancePublished content, assignments and acknowledgement evidence.
handovers:readHandover & ContinuityHoliday, shift and role handovers with their items and recipients.
transitions:readEmployee TransitionsJoiner and leaver checklists and what each person still holds.
assets:readAssets & MaintenanceEquipment, assignments, custody history and warranty dates.
workplace:readWorkplace OperationsWorkplace records and the people they concern.
people:readPeopleThe employee directory: names, work contact details, roles and teams.
locations:readLocationsSites, departments and teams.
tasks:readTasksWork generated by handovers and learning assignments.

The machine-readable contract

/developers/openapi.json describes this surface as OpenAPI, and is generated from the same routes. Use it to build a client rather than typing one out.

It describes /api/v1 only. kitset's own browser client talks to other endpoints; those are internal, they change without notice, and they are not part of this contract.