customer-api
The Customer API is the public booking surface for end-user facing applications. It covers everything a customer can see and do — searching availability, placing bookings, managing their account, and more.
When to use the Customer API
Use the Customer API when you are building something your customers interact with directly:
- Custom booking flow — embed a fully branded booking experience inside your own app or website instead of redirecting to anny
- Headless checkout — drive the cart, checkout, and payment steps entirely from your own frontend
- Custom confirmation pages — retrieve booking and order details after checkout to render a tailored confirmation
- Opening hours and availability on public pages — display live schedule data on your website with no authentication required
- White-label experiences — build lobby screens, kiosks, or mobile apps on top of the Customer API
Many endpoints work without any authentication. For a custom OAuth2 client to authenticate your own users, contact support@anny.co with your use case.
Authentication — Optional Auth
Most Customer API endpoints work without a token. Providing a customer bearer token unlocks personal data and additional actions:
| Auth state | What's accessible |
|---|---|
| Anonymous | Availability, public resource/service info, booking lookup by number, checkout |
| Customer token | Own bookings, account data, communities, passes, queue tickets |
Authorization: Bearer {customer_access_token}
To authenticate your own users, you need a custom OAuth2 client — contact support@anny.co. See the Authentication guide for the full token flow.
Customer API vs Admin API
| Feature | Customer API | Admin API |
|---|---|---|
| Use case | End-user apps, booking widgets | Server-side automation, backend tooling |
| Auth | Optional — many endpoints work without a token | Required — API token or OAuth2 |
| Identifiers | Slugs, booking numbers, order numbers | Immutable UUIDs and integer IDs |
| Access | Public and customer-owned data only | Full read/write |
Resource Identifiers
The Customer API uses human-readable identifiers that appear in booking URLs:
| Entity | Identifier | Example |
|---|---|---|
| Resources | Slug | conference-room-berlin |
| Services | Slug | hourly-desk-booking |
| Organizations | Slug | acme-gmbh |
| Bookings | Booking number | BB123456789 |
| Orders | Order number | BO123456789 |
Use the Admin API if you need immutable internal IDs for storage in external systems.
Starting Points
| Guide | What it covers |
|---|---|
| Getting Started | First steps and quickstart |
| JSON:API Conventions | Request and response format |
| Authentication | Customer token flow, OAuth2, anonymous access |
| Availability & Booking Search | Search open slots, filter by service and resource |
| Customer Booking Lifecycle | View, modify, and cancel bookings |
| Order & Checkout Flow | Cart, checkout steps, payment |
| Plans & Subscriptions | Membership plans and recurring billing |
| Communities & Access Control | Community membership and access gates |
| Waitlist | Join and manage waitlists |
Base URLs
| Environment | URL |
|---|---|
| Production | https://b.anny.co |
| Gov-Cloud | https://b.anny.eu |
