Get
/v{version}/Locations/{id}
Locations are implicitly filtered by the user's read permission.
Security
API Key: api_key
Header parameter nameX-ApiKey
Api Key
API Key: session_id
Header parameter nameX-Session-Id
Session Id
Path parameters
id
integer (int32) Required
Unique ID of the location
version
stringRequired
The requested API version
Responses
200
Returns the location details.
object
Location details
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
Maximum2147483647
Permissions
object
Dictionary of UserGroupId and PermissionSet
property*
object additionalProperties
A set containing multiple entries containing one user group and its available permissions
Read
boolean
Write
boolean
ReceiveMessage
boolean
PhoneNumber
string
Phone number of the location
ZipCode
string
ZIP code of the location
400
Bad request
object
ValidationErrors
object
property*
Array of string additionalProperties
string
401
Unauthorized
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
403
Forbidden
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
404
Not Found
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500
Unexpected error
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties