Query All

Query All

Query All

Retrieves a page of installers for an account.

Request

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

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of Installers

Query Parameters

Name
Required
Type
Description
page
Number
Defaults to 1.
pageSize
Number
1 to 500, defaults to 25.
sortDirection
Text
asc or desc, defaults to asc.

Response

Headers

None

Status Code

Code
Description
200 OK
The installers were 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 enabled, or the key lacks the required scope.

Body

Name
Type
Description
items
Object Array
The installers in this page of results. See Installer below.
total
Number
The total number of installers matching the query.
page
Number
The current page number.
pageSize
Number
The number of items returned per page.

Installer

Name
Type
Description
uniqueId
Guid
The unique ID of the installer.
userEmail
Text
The resolved user's email address.
commission
Number
The commission rate.