Query All

Query All

Query All

Retrieves a page of sales reps for an account.

Request

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

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 SalesReps

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 sales reps 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 sales reps in this page of results. See Sales Rep below.
total
Number
The total number of sales reps matching the query.
page
Number
The current page number.
pageSize
Number
The number of items returned per page.

Sales Rep

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