Locations — limble-api-v2

v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB

Routes

Locations

This request returns your Locations in Limble.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

EndFragment

Return data description

name | The name of the Location regionID | The ID of the region the Location is part of. A regionID of 0 means the location is not a part of any region. timezone | The Timezone the location is set at.List of Timezones weeklyOperationHours | The number of hours your Assets run at this location per week. This is used to help calculate MTBF. workRequestPortal | This is a URL you can use to submit Work Requests to this Location. geoLocation | The location of a Limble location on a Map. currencyCode | The ISO code for the currency at this location.

get/v2/locations

Query parameters

locationsinteger

This parameter is used to only get locations in the list provided. This parameter accepts a comma delimited list of Location IDs.

namestring

This parameter is used to only get specific locations by name. This parameter expects a string full name of a location or partial name with the wildcard %.

cursorinteger

This parameter is a cursor that selects what locationID you want to start receiving results at. e.g. passing 137 here will only get you locations with an id greater than 137.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time.

regionsinteger

This parameter is used to get locations that belong to a region. This parameter expects a regionID a location may belong to.

geoLocationboolean

This parameter is used to filter results that contain a geoLocation property. By default it is false and will return all locations with and without geoLocation property. If true, it will only return locations with a geoLocation property.

pageinteger

Response

Locations

locationIDinteger

namestring

regionIDinteger

timezonestring

weeklyOperationHoursinteger

{"stackTrail":"components:schemas:Location:properties:address","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:Location:properties:address2","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:Location:properties:phone","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:Location:properties:metaField1","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:Location:properties:metaField2","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:Location:properties:metaField3","oasType":"schema","type":"unknown"}

{"stackTrail":"components:schemas:Location:properties:geoLocation","oasType":"schema","type":"unknown"}

workRequestPortalstring uri

currencyCodestring