Appointment Endpoint
Appointments API access is read-only
Note: API Access is limited to Enterprise accounts and available upon request
Overview
The Appointments API allows Enterprise accounts to retrieve a paginated list of their appointments for a selected time period, including creation date/time, appointment start-end date/time, client, staff and service details.
Endpoint
Authentication
You must include a valid Authorization header using your SimpleSpa API Key:
Replace YOUR_API_KEY with your SimpleSpa Enterprise API Key.
Request Body
Field
Type
Required
Description
start
string
Yes
Start date in YYYY-MM-DD format
end
string
Yes
End date in YYYY-MM-DD format
status
integer
No
Appointment status code (optional)
page
integer
No
Page number (default: 1)
per_page
integer
No
Results per page (default: 1000 maximum)
Example Request
Example Response
Status Codes
Code
Description
0
New
5
Rebooked
7
Request
10
Online
12
Payment Due
15
Canceled
17
No-Show
20
Confirmed
22
Confirmed (No SMS)
25
Arrived
30
Paid
40
Completed
Notes
Important: for polling-based setup, all new records will be fetched together, which could lead to duplication unless filtered appropriately, please keep a record of those that have been contacted if you are using this for notifications
Limitation: Start/End date can range up to 92 days
Pagination: Default per_page is 100 if not specified. Maximum allowed is 1000 per page.
Rate Limiting: Please ensure reasonable usage to avoid throttling. It is recommended to poll no faster than once per minute.
Last updated