Get a list of locations above an existing location

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/Locations/{id}/Parents

Locations are searched from bottom to top, starting with the start location. Locations are implicitly filtered by the user's read permission. If the depth is 1, only locations directly above the starting location (one level up) will be loaded.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
id
integer (int32) Required

Unique ID of the location

version
stringRequired

The requested API version

Default"1.18"
Query parameters
depth
integer (int32)

Depth of the search

Minimum1.0
Maximum255.0
includePermissions
boolean

If true, the property Permissions is populated with the location's permissions. Default: false.

Responses
200

OK

Array of object
object

Location

AdditionalData
object

List of additional data of the location

property*
string additionalProperties
Address
string

Address of the location

CategoryIds
Array of integer

List of category IDs of the location

integer (int32)
City
string

City of the location

Country
string

Country of the location

Created
string (date-time)

Creation date in UTC

Email
string

Email address of the location

Fax
string

Fax number of the location

HolidayListIds
Array of integer

List of holiday list IDs of the location

integer (int32)
Id
integer (int32)

Unique ID of the location

Modified
string (date-time)

Modification date in UTC

Name
string

Name of the location

ParentId
integer (int32)

Unique ID of the parent location

Minimum1.0
Maximum2147483647.0
Permissions
object

Permissions.

Read
boolean
Write
boolean
ReceiveMessage
boolean
ZipCode
string

ZIP code of the location

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Forbidden

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties