API REFERENCE
REST endpoints, webhook events, authentication, and integration patterns for connecting OPS Companion to your existing infrastructure.
Overview
OPS Companion exposes a REST API and a WebSocket subscription layer for real-time events. The REST API follows standard HTTP conventions. Authentication uses JWT Bearer tokens. All responses are JSON.
https://api.ops-companion.tech/v1Bearer JWT tokenJSON (application/json)1,000 req/min5,000 req/minUnlimited1.3 requiredAuthentication
Obtain a JWT token by posting credentials to the auth endpoint. Include the token as a Bearer header in all subsequent requests.
REST Endpoints
/work-ordersGET, POST, PATCH, DELETEList, create, update, and delete work orders. Supports filtering by status, assignee, date range, and priority.
/assetsGET, POST, PATCHMachine and equipment registry. Query by make, model, client, GPS zone, or mechanical state.
/employeesGET, POST, PATCHEmployee roster management. Role assignment, certification records, contact information.
/inventoryGET, POST, PATCHMulti-warehouse parts inventory. Stock levels, warehouse locations, parts-to-machine linkage.
/quotesGET, POST, PATCHQuote pipeline management. Create quotes, update pipeline stage, retrieve acceptance status and signature data.
/gps-eventsGETGPS telemetry event stream. Query historical positions by asset, time range, or geofence zone.
/timesheetsGETPunch records and generated timesheets. Filter by employee, date range, or approval status.
/inspection-formsGET, POSTCompleted inspection form submissions. Includes photo attachments and electronic signatures.
Webhook Events
Configure webhook endpoints in the Admin dashboard. OPS Companion will POST a JSON payload to your URL for each subscribed event. All deliveries include a signature header for verification.
work_order.createdA new work order was createdwork_order.assignedA work order was assigned to a technicianwork_order.startedA technician began work on an orderwork_order.completedA work order was completed and signed offquote.createdA new quote was createdquote.sentA quote email was sent to the clientquote.acceptedA client accepted a quote with digital signatureasset.geofence_breachA machine entered or exited a restricted zoneemployee.punched_inAn employee punched in with GPS verificationemployee.punched_outAn employee punched outinspection.submittedAn inspection form was completed and signed?limit=50&offset=0 query parameters. The response includes a total count and next_cursor for cursor-based pagination on high-volume endpoints.