The Enterprise API comprises all the endpoints in the Acuity Public API and additional endpoints for Enterprise-specific functionality.
For general documentation on the Acuity public API please visit our documentation website.
Enterprise vs Public API Differences
All Public API endpoints are available when using a valid Enterprise API key, however, they have a different base URL. Enterprise API requests to Public API endpoints must include a userId in the URL. This indicates the effective user id.
Below are some examples of the endpoint differences between our Public API and Enterprise API:
| Public API | Enterprise API |
|---|---|
GET /api/v1/appointments | GET /api/enterprise/v1/users/:userId/appointments |
POST /api/v1/availability/check-times | POST /api/enterprise/v1/users/:userId/availability/check-times |
DELETE /api/v1/certificates/:id | DELETE /api/enterprise/v1/users/:userId/certificates/:id |