Locations

List all Locations

This endpoint allows you to list all Locations, including types building, location-folder and location.

The query parameters described below are to be used with the JQL.

get/locations

Request

  • Base URL: https://api.infraspeak.com/v3
  • URL: https://api.infraspeak.com/v3/locations
  • Auth: HTTP bearer

Query parameters

sc_searchstring

Unified search term applied against location name and full_code.

codestring

Filter results by given property value

full_codestring

Filter results by given property value

is_realboolean

Filter results by given property value

local_idstring

Filter results by given property value

parent_idstring

Filter results by given property value

root_parent_idstring

Filter results by given property value

s_with_assets_countboolean

Include cumulative assets count for each location (includes all descendant locations)

sortstring
Example:code-

Sorts the results by the specified field and direction.

The format is {field}{direction} where direction is + for ascending and - for descending. If no direction symbol is provided, ascending order is used by default.

Response

OK

Changes

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