Customers

Lists customers, oldest first, one page at a time.

Cursor pagination: pass the nextCursor of the previous response as after. Filters combine with AND. Example: GET /api/v1/customers?isActive=true&updatedSince=2026-01-01T00:00:00Z&limit=100. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/customers

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/customers
  • Auth: HTTP bearer

Query parameters

afterstring

SyncId of the last item of the previous page; omit for the first page.

limitinteger

Page size, 1–200 (default 50).

updatedSincestring date-time

Only customers created or edited at/after this UTC instant (ISO-8601, e.g. 2026-01-01T00:00:00Z).

isActiveboolean

Only active (true) or deactivated (false) customers; omit for both.

customerType'EndCustomer' | 'Installer' | 'Distributor' | 'Commercial'

Only this type: EndCustomer, Installer, Distributor or Commercial.

status'None' | 'Preferred' | 'Difficult'

Only this status flag: None, Preferred or Difficult.

searchstring

Case-insensitive substring matched against name, company name and e-mail.

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

A page of customers.

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.