Configuration

Get company configuration

Returns the company's configured vocabularies — the values its records are allowed to carry, as set up in Settings. Each list is in the order the company arranged it, and any of them may be empty.

GET

/configuration

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

{
  "data": {
    "lead_sources": [
      "Referral",
      "Google"
    ],
    "manual_payment_methods": [
      "Cash",
      "Check"
    ],
    "opportunity_lost_reasons": [
      "Went with competitor",
      "No budget"
    ],
    "service_frequencies": [
      "Monthly",
      "Quarterly"
    ],
    "service_plan_cancel_reasons": [
      "Too expensive",
      "Moved"
    ],
    "service_types": [
      "Window Cleaning",
      "Pressure Washing"
    ],
    "tags": [
      "VIP",
      "Commercial"
    ]
  },
  "status": "success"
}

These are the values the rest of this API expects: service_type filters take a name from service_types, tags filters take names from tags, and so on.

Authorizations

x-api-keystringheaderrequired

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

To obtain an API key:

Log into your Rotor dashboard
Go to Settings → Integrations → API Keys
Create a new key and select the scopes you need
Copy the key — it's only shown once!

Headers

rotor-api-versionenum<string>headerdefault:1.1.0required

Required OpenAPI version header.

Available options: 1.1.0

Example: 1.1.0

Response

Configuration retrieved successfully

dataobject

The company's configured vocabularies. Every list is user-maintained in Settings and may be empty.

Show child attributes

statusstring

Example: success

Still need help? Ask the team