Locations

Lists stock locations (warehouses, shelves, vehicles; job sites on request).

Requires ViewInventory. Job sites are excluded by default because one exists per job and stock there is never "on hand"; pass includeJobSites=true to see them. Cursor-paginated: pass the last location's syncId as after. Example: GET /api/v1/locations?search=van. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/locations

Request

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

Query parameters

searchstring

Case-insensitive match against name and address.

includeJobSitesboolean

Also return job-site locations (default false).

includeInactiveboolean

Also return locations whose status is not Active (default false).

parentLocationIdinteger

Only direct children of this location; 0 for top-level locations only.

updatedSincestring date-time

Only locations created or updated at/after this UTC instant.

afterstring

SyncId of the last location of the previous page.

limitinteger

Page size, 1..200 (default 50).

format'csv'

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

Response

One page of locations.

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.