Customers

Returns one location of a customer.

Send the previous ETag as If-None-Match to receive 304 Not Modified when unchanged; send it as If-Match on a PATCH to avoid overwriting a concurrent edit.

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

Request

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

Path parameters

idinteger required

Customer id.

locationIdinteger required

Location id from the customer's location list.

Response

The location, with an ETag header.

idinteger

Numeric id of the location. Stable within this organization.

syncIdstring uuid

Globally unique sync id (GUID). Use it as the after pagination cursor.

customerIdinteger

Id of the owning customer (matches the {id} in the URL).

namestring

Label given to the location, e.g. "Main Office" or "Rental Property 1".

addressstring nullable

Street address line 1.

address2string nullable

Street address line 2 (suite, unit).

citystring nullable

City.

statestring nullable

State / province.

postalCodestring nullable

ZIP / postal code.

countrystring nullable

Country.

isMailingAddressboolean

True when this is the customer's mailing address.

isActiveboolean

False when the location has been retired and should not be offered for new jobs.

notesstring nullable

Free-text notes about the site (gate codes, parking), max 500 characters.

createdAtstring date-time

UTC creation timestamp.

updatedAtstring date-time nullable

UTC timestamp of the last edit; null when never edited.

Changes

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