API v2 — Reference¶
calServer API v2 is a REST API built on Laravel 13 with Bearer token authentication.
Actively developed
API v2 fully covers the core modules: inventory (incl. device types, statuses, categories), calibration incl. test procedures, test steps and test standards, customers/contacts/locations incl. reservation/loan calendar, maintenance & repairs, orders (bookings) incl. prices, document management (DMS) and notepad, as well as support tickets & projects. Continuously extended. Purely internal administration features (user/role management, system configuration) are deliberately not part of this customer API.
Interactive Documentation¶
The complete API reference is available as interactive Scalar documentation:
Open interactive API docs (Scalar)
OpenAPI Specification¶
| Resource | Description |
|---|---|
| openapi-v2.yaml | OpenAPI 3.0 Specification (Download) |
Base URL¶
Authentication¶
See Authentication for token creation and the permissions concept.
Field names (API name)¶
The API name a field is exposed under is configurable per installation. By
default it is the V1 code (metrology / MetTrack code, e.g. I4206) so that
existing customers' integrations keep working; it can be switched to the
readable DB column name (serial_number) in field management. See
Field mapping for the details and the
copy-api-name endpoint.
Available Endpoints (Overview)¶
The table shows the most important resources with their base path. Most resources also offer sub-resources and actions (bulk operations, exports, PDF reports, status/workflow transitions, etc.). The complete list of all paths, parameters, request bodies, and response schemas is available in the interactive documentation.
| Resource | Methods | Description |
|---|---|---|
/api/v2/auth/token |
POST | Create Bearer token |
/api/v2/inventories |
GET, POST, PUT, DELETE | Inventory and asset management |
/api/v2/device-types |
GET, POST, PUT, DELETE | Device types incl. blueprint templates |
/api/v2/statuses |
GET, POST, PUT, DELETE | Status values and status transition rules |
/api/v2/categories |
GET, POST, PUT, DELETE | Categories for inventory, calibration, repair, booking |
/api/v2/calibrations |
GET, POST, PUT, DELETE | Calibrations incl. measurement results and calibration standards |
/api/v2/calibrations/{ctag}/reports |
GET | Calibration certificates/reports (generate, release, send via sub-actions) |
/api/v2/procedures |
GET, POST, PUT, DELETE | Test procedures and specifications |
/api/v2/calibrations/{ctag}/test-steps |
GET, POST, PUT | Test steps and guided measurement capture |
/api/v2/test-standards |
GET, POST, PUT, DELETE | Test standards |
/api/v2/customers |
GET, POST, PUT, DELETE | Customer management |
/api/v2/contacts |
GET, POST, PUT, DELETE | Contacts |
/api/v2/locations |
GET, POST, PUT, DELETE | Locations |
/api/v2/reservations/calendar |
GET | Reservation/loan calendar for rental equipment |
/api/v2/repairs |
GET, POST, PUT, DELETE | Maintenance and repairs |
/api/v2/bookings |
GET, POST, PUT, DELETE | Orders (bookings) incl. line items |
/api/v2/prices |
GET, POST, PUT, DELETE | Prices and price groups |
/api/v2/documents |
GET, POST, DELETE | Document management (DMS) |
/api/v2/signatures |
GET, POST, DELETE | Electronic signatures |
/api/v2/notepads |
GET, POST, PUT, DELETE | Notepad entries (appointments, reminders) |
/api/v2/tickets |
GET, POST, PUT, DELETE | Support ticket system incl. comments and attachments |
/api/v2/projects |
GET, POST, PUT, DELETE | Support projects (ticket grouping) |
/api/v2/audits |
GET | Audit trail (change history, read-only) |
/api/v2/search |
GET | Global quick search across inventory, customers, bookings, calibrations |
/api/v2/health |
GET | Health check |
The complete list of all endpoints with parameters, request bodies, and response schemas is available in the interactive documentation.