> ## Documentation Index
> Fetch the complete documentation index at: https://docs.anny.co/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](mailto: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 |

```http theme={null}
Authorization: Bearer {customer_access_token}
```

To authenticate your own users, you need a custom OAuth2 client — contact [support@anny.co](mailto:support@anny.co). See the [Authentication guide](https://docs.anny.co/developers/guides/authentication.md) 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 |

→ [Go to the Admin API](https://docs.anny.co/developers/api-reference/admin.md)

***

## 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](https://docs.anny.co/developers.md) | First steps and quickstart |
| [JSON:API Conventions](https://docs.anny.co/developers/guides/json-api-conventions.md) | Request and response format |
| [Authentication](https://docs.anny.co/developers/guides/authentication.md) | Customer token flow, OAuth2, anonymous access |
| [Availability & Booking Search](https://docs.anny.co/developers/guides/availability.md) | Search open slots, filter by service and resource |
| [Customer Booking Lifecycle](https://docs.anny.co/developers/guides/customer/booking-lifecycle.md) | View, modify, and cancel bookings |
| [Order & Checkout Flow](https://docs.anny.co/developers/guides/customer/checkout.md) | Cart, checkout steps, payment |
| [Plans & Subscriptions](https://docs.anny.co/developers/guides/customer/plans-subscriptions.md) | Membership plans and recurring billing |
| [Communities & Access Control](https://docs.anny.co/developers/guides/customer/communities.md) | Community membership and access gates |
| [Waitlist](https://docs.anny.co/developers/guides/customer/waitlist.md) | Join and manage waitlists |

***

## Base URLs

| Environment | URL |
| - | - |
| Production | `https://b.anny.co` |
| Gov-Cloud | `https://b.anny.eu` |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.