RemoteOps|API Reference

RemoteOps API Reference

The RemoteOps REST API gives your systems programmatic access to every part of field service operations — work orders, customers, assets, service contracts, invoices, calls, and inventory. Authentication uses Bearer tokens (API keys) scoped to your tenant, and every endpoint is described in an OpenAPI 3.1 specification so you can generate clients in any language. Multi-tenant by design: each API key is bound to a single tenant, and responses never cross organisation boundaries.

Prefer to inspect the raw spec? Download the OpenAPI JSON and pipe it into your code generator of choice. The full interactive reference — try-it-now requests, response schemas, and example payloads — loads below.

What the API covers

Seven domains, each documented with request and response schemas, status codes, and idempotency guarantees. A short tour of what lives where:

Work Orders: Create, assign, and close work orders. Track status transitions, attach photos and signatures, and read the full activity timeline. Filter by technician, site, priority, or SLA due date.
Customers and Sites: Manage customer accounts and the physical sites they operate. Each site holds its own assets, contracts, and service history — so a single customer with 40 locations stays organised.
Service Contracts: Recurring maintenance contracts with SLA terms, scheduled visits, and automatic work order generation. Read renewal dates, adjust scope, and pull contract-linked billing into invoices.
Invoices and Billing: Issue invoices against completed work orders or contract billing cycles. Apply credit notes, track payment status, and download locale-aware PDF copies in nine languages.
Calls and Voice Routing: Incoming VoIP calls mapped to the specific asset that generated them. Pull call records, transcripts, recordings, and the dispatcher routing decisions that followed.
Assets and Inventory: Equipment records with location, install date, and full service history. Track parts consumption, stock levels across warehouses and technician vans, and equipment checkout.
Webhooks and Events: Subscribe to domain events like work_order.assigned or invoice.paid. Payloads are signed with HMAC-SHA256, retried three times with exponential backoff, and delivered through a dead-letter queue on final failure.

Getting started

Generate an API key in Settings → API Keys, then call any endpoint with Authorization: Bearer rops_live_…. Rate limit is sixty requests per minute per key by default. The full reference below supports authenticated try-it-now requests against your own tenant.