Skip to main content
GET
The location tree with its materialised depth and path, and what sits in each branch.

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
site_id
string
site_code
string
parent_id
string
parent_name
string
location_type_id
string
location_type
string
level_hint
string
code
string
name
string
path
string
depth
string
latitude
string
longitude
string
is_active
string
children
string
assets
string
assets_in_branch
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

assets
integer<bigint>
assets_in_branch
integer<bigint>
children
integer<bigint>
code
string<character varying>
Maximum string length: 80
depth
integer<smallint>
id
string<uuid>

Note: This is a Primary Key.

is_active
boolean<boolean>
latitude
number<numeric>
level_hint
integer<smallint>
location_type
string<character varying>
Maximum string length: 150
location_type_id
string<uuid>

Note: This is a Foreign Key to location_type_settings.id.

longitude
number<numeric>
name
string<character varying>
Maximum string length: 200
parent_id
string<uuid>

Note: This is a Foreign Key to location_settings.id.

parent_name
string<character varying>
Maximum string length: 200
path
string<text>
row_version
integer<bigint>
site_code
string<character varying>
Maximum string length: 50
site_id
string<uuid>

Note: This is a Foreign Key to site_settings.id.