> ## 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.

# Getting Started

anny is a modern booking platform built to power demanding real-world scheduling — from co-working spaces and meeting rooms to medical clinics, rental fleets, and large-scale event venues. The API gives you programmatic access to everything: resources, services, availability, bookings, orders, customers, and more.

This guide helps you find the right API and the right starting point for what you're building.

***

## Two APIs, Two Audiences

anny exposes two distinct APIs. Pick the one that fits your integration:

<Columns cols={2}>
  <Card title="Admin API" icon="gear">
    **For backend developers and server-side integrations.**

    Full read/write access to your organization. Requires an API token from the admin dashboard — no OAuth setup needed to get started.

    Use it to automate workflows, sync data with external systems, build custom dashboards, and react to real-time events via webhooks.

    [Admin API Reference](/developers/api-reference/admin)
  </Card>

  <Card title="Customer API" icon="user">
    **For frontend developers building end-user experiences.**

    Public-facing surface for booking flows, availability displays, and customer account features. Many endpoints work without any token.

    Use it to embed a custom booking experience in your own app, display live availability on a public website, or build a headless checkout.

    [Customer API Reference](/developers/api-reference/customer)
  </Card>
</Columns>

***

## Which API do I need?

| I want to…                                | Use          |
| ----------------------------------------- | ------------ |
| Sync customer records from my CRM         | Admin API    |
| Create bookings from a back-office tool   | Admin API    |
| Issue or forward invoices to customers    | Admin API    |
| React to booking events via webhooks      | Admin API    |
| Feed live data to a digital display panel | Admin API    |
| Show availability on a public website     | Customer API |
| Embed a custom booking flow in my app     | Customer API |
| Build a headless checkout experience      | Customer API |
| Let customers manage their own bookings   | Customer API |

***

## Admin API — Getting Started

The Admin API is secured with an OAuth2 Bearer token scoped to your organization. The fastest way to get a token is directly from the dashboard — no OAuth flow needed.

<Steps>
  <Step title="Get an API token">
    Go to **[Organization Settings → API](https://app.anny.co/en-us/organization/settings/api)** in the admin panel and generate a long-lived access token. Copy it — you'll use it on every request.
  </Step>

  <Step title="Find your organization ID">
    Your organization ID (`o`) is required as a query parameter on every Admin API request. Find it in the URL of your admin dashboard or in the organization settings page.
  </Step>

  <Step title="Make your first request">
    ```bash theme={null}
    curl https://b.anny.co/api/v1/resources?o={organization_id} \
      -H "Authorization: Bearer {access_token}"
    ```
  </Step>

  <Step title="Subscribe to events (optional)">
    Register a webhook to receive real-time notifications when bookings are created, cancelled, or updated — no polling required.

    See the [Webhooks guide](/developers/guides/admin/webhooks).
  </Step>
</Steps>

***

## Customer API — Getting Started

Many Customer API endpoints require no authentication at all. You can start fetching availability and public resource data immediately.

<Steps>
  <Step title="Find the organization slug">
    Customer API requests are scoped by the organization's public slug (e.g. `acme-gmbh`). You can find it in the anny booking URL or ask the organization owner.
  </Step>

  <Step title="Fetch a resource — no token needed">
    ```bash theme={null}
    curl "https://b.anny.co/api/v1/resources/{resource_slug}"
    ```
  </Step>

  <Step title="Let customers authenticate (optional)">
    To access personal data — bookings, account details, passes — your customers need a bearer token. This requires a custom OAuth2 client. Contact [support@anny.co](mailto:support@anny.co) with your use case to request one.
  </Step>
</Steps>

***

## Platform Capabilities

anny handles the full complexity of real-world booking operations out of the box:

<Columns cols={3}>
  <Card title="Flexible Availability" icon="calendar">
    Multi-resource scheduling, schedule groups, custom blockers, capacity management, and real-time conflict detection.
  </Card>

  <Card title="Billing & Orders" icon="receipt">
    Full order lifecycle, invoicing, refunds, payment gateway integrations, and price modifiers including vouchers and dynamic pricing.
  </Card>

  <Card title="Communities & Access Control" icon="users">
    Membership groups, booking quotas, community-gated services, and granular access control per resource.
  </Card>
</Columns>

<Columns cols={3}>
  <Card title="Plans & Passes" icon="ticket">
    Subscription plans, booking passes, quota grants, and account skill tracking for complex membership models.
  </Card>

  <Card title="Webhooks & Automation" icon="arrows-rotate">
    Real-time event delivery for every booking state change. Integrates natively with Make.com and n8n for no-code automation.
  </Card>

  <Card title="Multi-tenant & White-label" icon="building">
    Full multi-tenancy with row-level isolation. Support for custom domains, white-label deployments, and Gov-Cloud hosting.
  </Card>
</Columns>

***

## Guides

Start here based on what you're building:

| Guide                                                               | What it covers                                             |
| ------------------------------------------------------------------- | ---------------------------------------------------------- |
| [Authentication](/developers/guides/authentication)                 | API tokens, OAuth2 flows, and customer authentication      |
| [Availability & Booking Search](/developers/guides/availability)    | Search open slots, filter by resource and service          |
| [Admin Booking Creation](/developers/guides/admin/booking-creation) | Create bookings and orders from the back office            |
| [Order & Checkout Flow](/developers/guides/customer/checkout)       | Customer-facing cart, checkout steps, and payment handling |
| [Webhooks & Events](/developers/guides/admin/webhooks)              | Real-time booking events and event-driven workflows        |
| [JSON:API Conventions](/developers/guides/json-api-conventions)     | Request format, filtering, pagination, and error handling  |

***

<Tip>
  Not sure where to start? For server-side integrations, grab an API token from the dashboard and try the [Admin Booking Creation](/developers/guides/admin/booking-creation) guide. For frontend work, the [Availability & Booking Search](/developers/guides/availability) guide needs no token at all.
</Tip>