API reference
Every endpoint in the equipment owner API, grouped by resource.
Auth
The identity your API key authenticates as.
Members
The people in your organisation, whatever their role. This is wider than the Member role, which a member’s role shows as member. Someone you invite becomes a member once they accept and sign up.
Teams
Groups of the members of your organisation. Available to manufacturers and equipment owners alike.
- get
/v1/teamsList teams - get
/v1/teams/{team_id}Retrieve a team - get
/v1/teams/{team_id}/membersList the members of a team
Folders
The places you keep equipment in: kit bags, locations, vehicles and the other folder types, nested in a tree.
Labels
The labels you tag items with, such as "Rescue kit". An item lists its labels, and the items list filters by one.
Items
The equipment in your inventory: each item with its status, folder, assignee, labels and inspection dates, its field values and inspection frequencies, and its history.
- get
/v1/itemsList items - get
/v1/items/{item_id}Retrieve an item - get
/v1/items/{item_id}/historyList the history of an item
Inspections
The inspections of the items in your inventory: the outcome, who carried each one out, and for a single inspection its checklist results, photos and PDFs. An item’s inspections from before your organisation held it are included without the inspector, notes or files.
Checklists
Your organisation’s inspection checklists and the checks on each. Checklists a manufacturer provides for its products aren’t listed here, though an inspection made against one shows its name and results.
Examinations
Thorough examinations: a set of inspections issued together as one report, such as an annual LOLER examination. Download the report as a PDF.
- get
/v1/examinationsList examinations - get
/v1/examinations/{examination_id}Retrieve an examination - get
/v1/examinations/{examination_id}/pdfDownload an examination report
Inspection frequencies
Your inspection schedules, such as every six months. Applied to an item, each sets when its next inspection is due; an item lists the ones applied to it.
Inspection frequencies
Read the inspection schedules you apply to your equipment.
Get the authenticated identity GET
Returns the organisation you act in, its type, and who you are: how you authenticated, the user you act as, and the `roles` or `scopes` your requests are judged against. Any API key with at least one scope can call this endpoint. Check `roles` (OAuth) or `scopes` (API key) to predict a 403.