API reference

Rotor OpenAPI1.1.0

Public-facing API for Rotor — a CRM and field service platform built for home service businesses.

Current version: 1.1.0

Authentication

All requests must be authenticated with a company API key.

API keys are scoped to a specific company and can be managed by company administrators in Settings → Integrations → API Keys.

Each API key is limited to 1000 requests per UTC day across all OpenAPI endpoints.

Each API key is granted specific scopes that control what actions it can perform:

Scope	Description
`leads:create`	Create and update leads
`leads:read`	Read lead records
`customers:create`	Create and update customers
`customers:read`	Read customer records
`service_plans:read`	Read service plan records
`jobs:read`	Read serviced job records
`pins:read`	Read pin records and pin types
`timesheets:read`	Read timesheet records and visit timer records
`tasks:read`	Read task records
`tasks:create`	Create tasks
`tasks:update`	Update tasks
`configuration:read`	Read company configuration (service types, line item templates)

Set the required version header: Send rotor-api-version: 1.1.0 with every request
Create an API key: Go to Settings → Integrations → API Keys, create a key with the scopes you need
For testing: Use GET /auth/test to verify your credentials

All requests use one of these base URLs:

x-api-keystringheaderAPI key

Company API key in the format: rotor_{keyId}_{keySecret}

To obtain an API key:

curl --request GET \
  --url https://api.getrotor.com/open-api/auth/test \
  --header 'x-api-key: <api-key>' \
  --header 'rotor-api-version: 1.1.0'

rotor-api-versionenum<string>headerrequired

Required OpenAPI version header.

Available options: 1.1.0

Example: 1.1.0

Still need help? Ask the team