Customers

Lists the additional locations (job sites / addresses) of one customer.

The customer's primary address is on the customer resource itself; this collection holds the extra sites jobs can be booked at. Cursor-paginated like every list. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/customers/{id}/locations

Request

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

Path parameters

idinteger required

Customer id.

Query parameters

afterstring

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

limitinteger

Page size, 1–200 (default 50).

isActiveboolean

Only active (true) or retired (false) locations; omit for both.

format'csv'

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

Response

A page of locations (may be empty).

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.