Query All

Query All

Query All

Retrieves a page of appointment types for an account.

Request

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

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 AccountLists

Query Parameters

Name
Required
Type
Description
page
Number
The page number to retrieve. Defaults to 1.
pageSize
Number
The number of items per page, from 1 to 500. Defaults to 25.
sortDirection
Text
asc or desc. Defaults to asc.
active
Boolean
Filters to active (true) or inactive (false) appointment types. Omit to return both.

Response

Headers

None

Status Code

Code
Description
200 OK
The page of appointment types was 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 does not have the required scope.

Body

Name
Type
Description
items
Object Array
An array of appointment type objects, in the same shape as the Create response body.
total
Number
The total number of matching appointment types across all pages.
page
Number
The page returned.
pageSize
Number
The page size used.