Fresh start - excluded large ROM JSON files
This commit is contained in:
154
skills/api-gateway/references/acuity-scheduling.md
Normal file
154
skills/api-gateway/references/acuity-scheduling.md
Normal file
@@ -0,0 +1,154 @@
|
||||
# Acuity Scheduling Routing Reference
|
||||
|
||||
**App name:** `acuity-scheduling`
|
||||
**Base URL proxied:** `acuityscheduling.com`
|
||||
|
||||
## API Path Pattern
|
||||
|
||||
```
|
||||
/acuity-scheduling/api/v1/{resource}
|
||||
```
|
||||
|
||||
The gateway automatically prepends `/api/v1` when proxying to Acuity.
|
||||
|
||||
## Common Endpoints
|
||||
|
||||
### Get Account Info
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/me
|
||||
```
|
||||
|
||||
### List Appointments
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/appointments?max=100&minDate=2026-02-01
|
||||
```
|
||||
|
||||
### Get Appointment
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/appointments/{id}
|
||||
```
|
||||
|
||||
### Create Appointment
|
||||
```bash
|
||||
POST /acuity-scheduling/api/v1/appointments
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"datetime": "2026-02-15T09:00",
|
||||
"appointmentTypeID": 123,
|
||||
"firstName": "John",
|
||||
"lastName": "Doe",
|
||||
"email": "john@example.com"
|
||||
}
|
||||
```
|
||||
|
||||
### Update Appointment
|
||||
```bash
|
||||
PUT /acuity-scheduling/api/v1/appointments/{id}
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"firstName": "Jane",
|
||||
"lastName": "Smith"
|
||||
}
|
||||
```
|
||||
|
||||
### Cancel Appointment
|
||||
```bash
|
||||
PUT /acuity-scheduling/api/v1/appointments/{id}/cancel
|
||||
```
|
||||
|
||||
### Reschedule Appointment
|
||||
```bash
|
||||
PUT /acuity-scheduling/api/v1/appointments/{id}/reschedule
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"datetime": "2026-02-20T10:00"
|
||||
}
|
||||
```
|
||||
|
||||
### List Calendars
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/calendars
|
||||
```
|
||||
|
||||
### List Appointment Types
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/appointment-types
|
||||
```
|
||||
|
||||
### Get Available Dates
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/availability/dates?month=2026-02&appointmentTypeID=123
|
||||
```
|
||||
|
||||
### Get Available Times
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/availability/times?date=2026-02-04&appointmentTypeID=123
|
||||
```
|
||||
|
||||
### List Clients
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/clients?search=John
|
||||
```
|
||||
|
||||
### Create Client
|
||||
```bash
|
||||
POST /acuity-scheduling/api/v1/clients
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"firstName": "John",
|
||||
"lastName": "Doe",
|
||||
"email": "john@example.com"
|
||||
}
|
||||
```
|
||||
|
||||
### List Blocks
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/blocks?calendarID=1234
|
||||
```
|
||||
|
||||
### Create Block
|
||||
```bash
|
||||
POST /acuity-scheduling/api/v1/blocks
|
||||
Content-Type: application/json
|
||||
|
||||
{
|
||||
"start": "2026-02-15T12:00",
|
||||
"end": "2026-02-15T13:00",
|
||||
"calendarID": 1234
|
||||
}
|
||||
```
|
||||
|
||||
### Delete Block
|
||||
```bash
|
||||
DELETE /acuity-scheduling/api/v1/blocks/{id}
|
||||
```
|
||||
|
||||
### List Forms
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/forms
|
||||
```
|
||||
|
||||
### List Labels
|
||||
```bash
|
||||
GET /acuity-scheduling/api/v1/labels
|
||||
```
|
||||
|
||||
## Notes
|
||||
|
||||
- Datetime values must be parseable by PHP's `strtotime()` function
|
||||
- Timezones use IANA format (e.g., "America/New_York")
|
||||
- Use `max` parameter to limit results (default: 100)
|
||||
- Use `minDate` and `maxDate` for date-range filtering
|
||||
- Client update/delete only works for clients with existing appointments
|
||||
- Rescheduling requires the new datetime to be an available time slot
|
||||
|
||||
## Resources
|
||||
|
||||
- [Acuity Scheduling API Quick Start](https://developers.acuityscheduling.com/reference/quick-start)
|
||||
- [Appointments API](https://developers.acuityscheduling.com/reference/get-appointments)
|
||||
- [Availability API](https://developers.acuityscheduling.com/reference/get-availability-dates)
|
||||
- [OAuth2 Documentation](https://developers.acuityscheduling.com/docs/oauth2)
|
||||
Reference in New Issue
Block a user