Service

List serviced jobs

Returns a paginated list of completed jobs for the authenticated company. By default only completed jobs are returned (only_completed defaults to true). Results are ordered by created_at (newest first).

GET

/serviced-jobs

List serviced jobs

curl --request GET \
  --url 'https://api.getrotor.com/open-api/serviced-jobs?page=1&limit=50&only_completed=true&service_date_range_start=2026-01-01T00%3A00%3A00Z&service_date_range_end=2026-12-31T23%3A59%3A59Z&line_item_text_contains=window%20cleaning&paid_at_range_start=2026-01-01T00%3A00%3A00Z&paid_at_range_end=2026-12-31T23%3A59%3A59Z' \
  --header 'x-api-key: <api-key>' \
  --header 'rotor-api-version: 1.1.0'

{
  "data": [
    {
      "billing_cycle_ids": [
        "9f8b2c1a-1111-4111-8111-111111111111"
      ],
      "customer": {
        "company_name": "<string>",
        "first_name": "<string>",
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "last_name": "<string>"
      },
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "line_items": [
        {
          "description": "Full exterior window cleaning including screens",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "title": "Window Cleaning - Exterior",
          "total_price": 120
        }
      ],
      "payments": [
        {
          "amount": 150,
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "payment_date": "2026-06-15T10:30:00Z",
          "payment_method": "stripe",
          "payment_type": "invoice",
          "status": "succeeded",
          "tip": 20
        }
      ],
      "service_date": "2026-06-15T08:00:00Z",
      "service_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "service_types": [
        "<string>"
      ],
      "status": "Completed",
      "technicians": [
        {
          "email": "jsmith@example.com",
          "name": "John Doe",
          "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        }
      ],
      "total_outstanding": 0,
      "total_received": 150
    }
  ],
  "pagination": {
    "has_more": true,
    "limit": 50,
    "page": 1,
    "total": 142
  },
  "status": "success"
}

The service_date is taken from the first visit's start time. total_received and total_outstanding are in dollars.

Note: When service_date_range_start or service_date_range_end are provided, filtering is applied against the first visit's start time. Because this is evaluated after the database query, pagination totals reflect the filtered count.

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!

Query Parameters

pageintegerquerydefault:1

Page number (1-based)

Required range: 1 <= x

Example: 1

limitintegerquerydefault:50

Number of results per page (max 1000)

Required range: 1 <= x <= 1000

Example: 50

only_completedbooleanquerydefault:true

When true (default), only return jobs with status Completed. Set to false to include all non-archived, non-quote jobs.

Example: true

service_date_range_startstringquery

Return jobs whose first visit starts on or after this date (ISO 8601)

Example: 2026-01-01T00:00:00Z

service_date_range_endstringquery

Return jobs whose first visit starts on or before this date (ISO 8601)

Example: 2026-12-31T23:59:59Z

line_item_text_containsstringquery

Filter jobs where any line item's title or description contains this text (case-insensitive)

Example: window cleaning

paid_at_range_startstringquery

Return jobs that have a succeeded invoice payment on or after this date (ISO 8601)

Example: 2026-01-01T00:00:00Z

paid_at_range_endstringquery

Return jobs that have a succeeded invoice payment on or before this date (ISO 8601)

Example: 2026-12-31T23:59:59Z

Headers

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

Required OpenAPI version header.

Available options: 1.1.0

Example: 1.1.0

Response

Serviced jobs listed successfully

dataobject[]

Show child attributes

paginationobject

Show child attributes

statusstring

Example: success

Still need help? Ask the team