Query

Query

Query

Retrieves a single location from an account.

Request

Method
URL
GET
 https://api.solatech-dos.com/lists/v1/accounts/{accountUniqueId}/departments/{itemUniqueId} 

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.
itemUniqueId

Guid
The unique ID of the location.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Response

Headers

None

Status Code

Code
Description
200 OK
The location was found and is returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API-keys feature, or the key does not have the required scope.
404 Not Found
No location was found with that id for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the location.
name
Text
The name of the location.
active
Boolean
Indicates if the location is active or inactive.