> ## 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.
# Get a list of add-ons
## OpenAPI
````yaml /developers/openapi/admin.openapi.json get /api/v1/add-ons
openapi: 3.1.0
info:
title: admin-api
version: '1.0'
description: >-
The Admin API gives you **full programmatic access** to your anny
organization. It is built for **server-side integrations** — backend
services, automation scripts, and custom tooling that act on behalf of your
team.
---
## When to use the Admin API
Use the Admin API when you need to **drive workflows from your own
systems**:
- **Sync membership data** — create or update customers, assign them to
communities, reflect subscription status from an external CRM
- **Create bookings programmatically** — build back-office tools or automate
repeat reservations without going through the customer checkout
- **Issue and forward invoices** — generate invoices, send them to
customers, or push them to your accounting system
- **React to real-time events** — pair the API with
[Webhooks](/developers/guides/admin/webhooks) to trigger side effects
whenever a booking is created, cancelled, or checked in
- **Drive display panels** — push live occupancy and schedule data to
digital signage or lobby displays
Combined with [webhook subscriptions](/developers/guides/admin/webhooks),
you can build fully automated, event-driven workflows without polling.
---
## Authentication
Generate a long-lived API token directly in the admin dashboard under
**Organization Settings → API**. All requests require it in the
`Authorization` header:
```
Authorization: Bearer {access_token}
```
Every endpoint is **organization-scoped**. Pass your organization ID as a
query parameter on every request:
```
?o={organization_id}
```
See the [Authentication guide](/developers/guides/authentication) for token
scopes and the full OAuth2 flow.
---
## Admin API vs Customer API
| | Admin API | Customer API |
|---|---|---|
| **Use case** | Server-side automation, backend tooling | End-user apps,
booking widgets |
| **Auth** | Required — API token or OAuth2 | Optional — many endpoints work
without a token |
| **Identifiers** | Immutable UUIDs and integer IDs | Slugs, booking
numbers, order numbers |
| **Access** | Full read/write | Public and customer-owned data only |
→ [Go to the Customer API](/developers/api-reference/customer)
---
## Resource Identifiers
The Admin API uses **immutable IDs** — UUIDs for most entities, integers for
legacy ones. These are safe to store in external systems and never change,
even if an organization renames a resource.
---
## Starting Points
| Guide | What it covers |
|---|---|
| [Getting Started](/developers) | First steps and quickstart |
| [JSON:API Conventions](/developers/guides/json-api-conventions) | Request
and response format |
| [Authentication](/developers/guides/authentication) | API tokens, OAuth2,
scopes |
| [Availability & Booking Search](/developers/guides/availability) | Search
open slots and timeslots |
| [Admin Booking Creation](/developers/guides/admin/booking-creation) |
Create bookings from the back office |
| [Admin Booking Lifecycle](/developers/guides/admin/booking-lifecycle) |
Status changes, check-in, cancellations |
| [Invoices](/developers/guides/admin/invoices) | Create, send, and manage
invoices |
| [Customer Management](/developers/guides/admin/customer-management) |
Create and manage customer records |
| [Booking Calendars](/developers/guides/admin/calendar-events) | Custom
calendar events |
| [Timeslot Management](/developers/guides/admin/timeslot-management) |
Manage timeslot CRUD, recurrence, allocations, and rescheduling |
| [Broadcast Campaigns](/developers/guides/admin/broadcasting) | Email and
push campaigns |
| [Exports](/developers/guides/admin/exports) | Export bookings and customer
data |
| [Webhooks & Events](/developers/guides/admin/webhooks) | Subscribe to
real-time events |
---
## Base URLs
| Environment | URL |
|---|---|
| Production | `https://b.anny.co` |
| Gov-Cloud | `https://b.anny.eu` |
contact:
name: anny GmbH
url: https://anny.co
email: support@anny.co
servers:
- url: https://b.anny.co
description: Production
- url: https://b.anny.eu
description: Gov-Cloud
security:
- Bearer: []
tags:
- name: Add-On Groups
- name: Add-Ons
- name: Booking Add-Ons
- name: Booking Bundles
- name: Booking Passes
- name: Booking Quota Grants
- name: Booking Quotas
- name: Booking Rules
- name: Bookings
- name: Broadcast Campaigns
- name: Broadcasts
- name: Calendars
- name: Cancellation Policies
- name: Communities
- name: External Links
- name: Community Invites
- name: Custom Fields
- name: Custom Forms
- name: Customers
- name: Businesses
- name: Display Panels
- name: Displays
- name: Document Templates
- name: Exports
- name: External Calendars
- name: Files
- name: Images
- name: Invoices
- name: Items
- name: Legal Document Links
- name: Legal Documents
- name: Model Identifiers
- name: Orders
- name: Organizations
- name: Payment Setups
- name: Payments
- name: Plan Subscriptions
- name: Price Modifiers
- name: Properties
- name: Queues
- name: Resource Categories
- name: Resource Groups
- name: Resource Properties
- name: Resources
- name: Scans
- name: Schedule Groups
- name: Schedules
- name: Service Add-Ons
- name: Service Groups
- name: Services
- name: Sub-Resources
- name: Test-Results
- name: Test Results
- name: Tests
- name: Timeslot Allocations
- name: Timeslot Series
- name: Timeslots
- name: User Invites
- name: Users
- name: Customer Balances
- name: Vouchers
- name: Webhooks
paths:
/api/v1/add-ons:
get:
tags:
- Add-Ons
summary: Get a list of add-ons
operationId: list-add-ons
parameters:
- schema:
type: string
in: query
name: page[number]
- schema:
type: string
in: query
name: page[size]
- schema:
type: string
in: query
name: sort
- schema:
type: string
in: query
name: o
description: Organization ID
responses:
'200':
description: OK
content:
application/vnd.api+json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/add-ons.v1'
examples:
default:
value:
data:
- type: add-ons
id: '238'
attributes:
name: Coaching at your office
description: >-
Want our coaches to conduct the training at your
place? Say no more!
plain_description: >-
Want our coaches to conduct the training at your
place? Say no more!
customer_notice: null
lead_time: 0
is_third_party: false
is_net_price: false
currency: EUR
tax_rate: 19
price: 50
links:
self: https://b.anny.co/api/v1/add-ons/238
- type: add-ons
id: '239'
attributes:
name: Vegan Food
description: >-
We will ensure all snacks offered will be
vegan.
plain_description: We will ensure all snacks offered will be vegan.
customer_notice: 'Select # of vegan attendees'
lead_time: 0
is_third_party: false
is_net_price: false
currency: EUR
tax_rate: 19
price: 0
links:
self: https://b.anny.co/api/v1/add-ons/239
'401':
description: Unauthorized
security:
- Bearer: []
components:
schemas:
add-ons.v1:
$schema: https://json-schema.org/draft/2020-12/schema
x-version: 1.1.0
title: Add-On
type: object
description: >-
An optional extra that can be added to a booking (e.g., equipment
rental, catering).
x-tags:
- Models
- Services
properties:
id:
type: string
type:
type: string
default: addons
attributes:
type: object
properties:
name:
type: string
description: Add-on name
description:
type:
- string
- 'null'
description: Rich text description
plain_description:
type:
- string
- 'null'
description: Plain text description
customer_notice:
type:
- string
- 'null'
description: Notice shown to customers
lead_time:
type: integer
description: Lead time in minutes
is_third_party:
type: boolean
description: Whether provided by third party
featured:
type: boolean
description: Whether featured in listing
full_refund:
type: boolean
description: Whether fully refundable
is_net_price:
type: boolean
description: Whether price is net
currency:
type: string
description: ISO 4217 currency code
tax_rate:
type: number
description: Tax rate
price_type:
type: string
enum:
- fixed
- per_unit
- staggered
description: Pricing type
price:
type: number
description: Base price
staggered_pricing:
type: array
description: Staggered pricing tiers
min_quantity:
type: integer
description: Minimum quantity
max_quantity:
type: integer
description: Maximum quantity
calculation_interval:
type:
- string
- 'null'
description: Calculation interval
calculation_unit:
type:
- string
- 'null'
description: Calculation unit
links:
$ref: '#/components/schemas/links.v1'
relationships:
type: object
properties:
cover_image:
type: object
description: Cover image
properties:
data:
type:
- object
- 'null'
properties:
type:
type: string
id:
type: string
links:
$ref: '#/components/schemas/links.v1'
group:
type: object
description: Add-on group
properties:
data:
type:
- object
- 'null'
properties:
type:
type: string
id:
type: string
links:
$ref: '#/components/schemas/links.v1'
links.v1:
$schema: https://json-schema.org/draft/2020-12/schema
x-version: 1.1.0
title: ResourceLinks
x-tags:
- Models
type: object
description: JSON:API self-link object
properties:
self:
type: string
format: uri
securitySchemes:
Bearer:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://auth.anny.co/oauth/authorize
tokenUrl: https://auth.anny.co/oauth/token
refreshUrl: https://auth.anny.co/oauth/token/refresh
scopes: {}
````