> ## 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 resource ## OpenAPI ````yaml /developers/openapi/customer.openapi.json get /api/v1/resources/{resource_slug} openapi: 3.1.0 info: title: customer-api version: '1.0' contact: name: anny GmbH url: anny.co email: support@anny.co description: >- 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 | ``` 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](/developers/guides/authentication) 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](/developers/api-reference/admin) --- ## 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](/developers) | First steps and quickstart | | [JSON:API Conventions](/developers/guides/json-api-conventions) | Request and response format | | [Authentication](/developers/guides/authentication) | Customer token flow, OAuth2, anonymous access | | [Availability & Booking Search](/developers/guides/availability) | Search open slots, filter by service and resource | | [Customer Booking Lifecycle](/developers/guides/customer/booking-lifecycle) | View, modify, and cancel bookings | | [Order & Checkout Flow](/developers/guides/customer/checkout) | Cart, checkout steps, payment | | [Plans & Subscriptions](/developers/guides/customer/plans-subscriptions) | Membership plans and recurring billing | | [Communities & Access Control](/developers/guides/customer/communities) | Community membership and access gates | | [Waitlist](/developers/guides/customer/waitlist) | Join and manage waitlists | --- ## Base URLs | Environment | URL | |---|---| | Production | `https://b.anny.co` | | Gov-Cloud | `https://b.anny.eu` | termsOfService: https://anny.co/terms-of-use x-logo: url: https://cdn.anny.co/cms/anny_logo_main_colour_blue_4865e76654.svg altText: anny logo href: https://anny.co servers: - url: https://b.anny.co description: Production - url: https://b.anny.eu description: Gov-Cloud security: [] tags: - name: Account Passes - name: Account Skills - name: Addresses - name: Availability - name: Booking Bundles - name: Booking Passes - name: Booking Quota Grants - name: Bookings - name: Communities - name: Community Accounts - name: Community Invites - name: Customer Accounts - name: Favorites - name: Orders - name: Organizations - name: Plan Subscriptions - name: Properties - name: Queues - name: Queue Tickets - name: Resources - name: Services - name: Waitlist paths: /api/v1/resources/{resource_slug}: parameters: - schema: type: string name: resource_slug in: path required: true get: tags: - Resources summary: Get a resource operationId: get-resources-record parameters: - schema: type: string enum: - cover_image - schedules - gallery_images - organization - category - resource_properties.property - services - organization.address - organization.logo_image - services.cancellation_policy - resource_properties.property - services.group - location - communities example: >- cover_image,schedules,gallery_images,organization.address,organization.logo_image,category,services.cancellation_policy,resource_properties.property,services.group,location,communities in: query name: include responses: '200': description: OK content: application/vnd.api+json: schema: type: object properties: data: $ref: '#/components/schemas/resources.v1' examples: default: value: data: type: resources id: '3049' attributes: slug: flex-desks-ku5zbxkhop name: Flex Desks description: null plain_description: '' availabilityMode: null continuous: true color: null auto_accept_bookings: true timezone: Europe/Berlin quantity: 25 staggered_quantity: null max_booking_quantity: 1 max_sequence_quantity: 10 has_children: false available_from: null available_to: null viewing_requires_community: false booking_requires_community: false latitude: 50.93574 longitude: 6.951823 has_map: false is_online: false allow_multi_service: false create_booking_sequence: false relationships: cover_image: data: type: images id: '1652' gallery_images: data: - type: images id: '1652' organization: data: type: organizations id: '281' category: data: type: resource-categories id: '91' resource_properties: data: [] schedules: data: - type: schedules id: '4837' - type: schedules id: '4838' - type: schedules id: '4839' - type: schedules id: '4840' - type: schedules id: '4841' services: data: - type: services id: '1016' location: data: type: addresses id: '28538' communities: data: - type: communities id: sot-flex-H5y9NsEC links: self: https://b.staging.anny.co/api/v1/resources/3049 meta: is_available: null display_quota: 25 booking_count: null number_available: null availability_result: null minimal_service: name: Flex Day Pass currency: EUR has_flexible_duration: false uncharged_duration: 0 min_duration: 1 min_price_max_duration: 1 min_duration_total: 25 starting_fee: 0 calculation_interval: 1 price: 25 is_net_price: true price_hidden: false price_label: null unit: day auto_duration: false service_list: Flex Day Pass, Member Day Pass services_count: null settings: showAvailabilityCalendar: false showAvailability: true showLocation: true showServiceList: false minimizeCoverImage: false showAvailabilityCount: false checkout: customerCanPickChildren: false requiresLogin: false requiresLoginReason: null verifyGuestEmail: false checkIn: isEnabled: false selfCheckIn: isEnabled: false disabledUntil: 15 allowedUntil: 0 autoCheckInEnabled: true checkOutEnabled: true allowedOverrunTime: 60 geoCheckEnabled: true geoCheckMaxDelta: 1000 meta_settings: showAvailabilityCalendar: false showAvailability: true showLocation: true showServiceList: false minimizeCoverImage: false showAvailabilityCount: false checkout: customerCanPickChildren: false requiresLogin: false requiresLoginReason: null verifyGuestEmail: false checkIn: isEnabled: false selfCheckIn: isEnabled: false disabledUntil: 15 allowedUntil: 0 autoCheckInEnabled: true checkOutEnabled: true allowedOverrunTime: 60 geoCheckEnabled: true geoCheckMaxDelta: 1000 zoom: false teams: false platform_id: null included: - type: images id: '1652' attributes: url: >- https://cdn.staging.booking-buddy.de/public/images/gallery/large/8lXw6fZhrjfttntyt2Rxewb7j.jpg copyright: Helena Lopes width: '1080' height: '720' order_index: '0' preview_image_base64: >- data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEAYABgAAD//gA7Q1JFQVRPUjogZ2QtanBlZyB2MS4wICh1c2luZyBJSkcgSlBFRyB2ODApLCBxdWFsaXR5ID0gOTAK/9sAQwADAgIDAgIDAwMDBAMDBAUIBQUEBAUKBwcGCAwKDAwLCgsLDQ4SEA0OEQ4LCxAWEBETFBUVFQwPFxgWFBgSFBUU/9sAQwEDBAQFBAUJBQUJFA0LDRQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQUFBQU/8AAEQgADQAUAwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/aAAwDAQACEQMRAD8A8G8Fa9Yt4W8OR2fh9rfTJNVeIX7om5nZI1we+0EEAnqScDINek/HW10G58bz3FxBdaVBpkFta3EOjYEl4MKWnDkoFcr8rE7vvA5+Xn5v8N/HHU/C3huPR49Ns7mO3LxwzSF96ht55G7acbyBx6elEvjrUvHuu215qMrJfytAqXFsRH5Y8wjGAPQ+o6CvPdBrmk9F/wAOd8MRSTjHd/8ADeny/wAjP8YW9jZeIbtYys8bOzIbpjNKF3EAM4IDEADnA+gorpNd8ASXGoPO2sXOJcsFIJKjcRjOeen60V0U01BaHHWTdSTXc//Z small_path: >- https://cdn.staging.booking-buddy.de/public/images/gallery/small/8lXw6fZhrjfttntyt2Rxewb7j.jpg medium_path: >- https://cdn.staging.booking-buddy.de/public/images/gallery/medium/8lXw6fZhrjfttntyt2Rxewb7j.jpg large_path: >- https://cdn.staging.booking-buddy.de/public/images/gallery/large/8lXw6fZhrjfttntyt2Rxewb7j.jpg created_at: '2023-03-24T15:00:02+00:00' - type: addresses id: '28538' attributes: name: null street_address: Cäcilienstr. 30 zip_code: '50667' city: Köln country_code: DE latitude: 50.93574 longitude: 6.951823 meta: address_line: Cäcilienstr. 30, 50667 Köln, DE - type: images id: '1647' attributes: url: >- https://cdn.staging.booking-buddy.de/public/images/gallery/original/co-working-logo-placeholder.png copyright: Unsplash License width: 1080 height: 720 order_index: '0' preview_image_base64: null small_path: >- https://cdn.staging.booking-buddy.de/public/images/gallery/original/co-working-logo-placeholder.png medium_path: >- https://cdn.staging.booking-buddy.de/public/images/gallery/original/co-working-logo-placeholder.png large_path: >- https://cdn.staging.booking-buddy.de/public/images/gallery/original/co-working-logo-placeholder.png created_at: '2023-03-24T14:55:03+00:00' - type: organizations id: '281' attributes: slug: spaces-of-tomorrow name: Spaces of tomorrow live: true description: null plain_description: '' official_name: Spaces of Tomorrow GmbH support_email: max.mustermann@anny.co phone: null currency: EUR timezone: Europe/Berlin is_organization: true responsible_for_contents: Lucian Holtwiesche ceo: null vat_id: null country_code: DE register_number: null local_court: null financial_office: null features: [] viewing_requires_community: false booking_requires_community: false selected_category: meeting-rooms business_type: company business_size: 100-249 accepted_documents: - tos-2022-11-15 - payment-terms-2022-11-15 relationships: address: data: type: addresses id: '28538' logo_image: data: type: images id: '1647' meta: platform_id: null settings: organizeResourcesBy: category labelFormat: 90x29 barcodeFormat: C39 checkout: additionalFields: - given_name - family_name additionalRequiredFields: - given_name - family_name preferFormalSalutation: false mobileNotifications: isEnabled: false meta_settings: organizeResourcesBy: category labelFormat: 90x29 barcodeFormat: C39 checkout: additionalFields: - given_name - family_name additionalRequiredFields: - given_name - family_name preferFormalSalutation: false mobileNotifications: isEnabled: false active_integration_keys: [] hide_unavailable_days: false - type: resource-categories id: '91' attributes: slug: flex-desks name: Flex-Desk plural_name: Flex-Desks is_location: true schema_type: Room is_rentable: true created_at: '2022-09-08T15:30:33+00:00' illustration: null relationships: industries: [] - type: schedules id: '4837' attributes: start_time: '07:00:00' local_start_time: '09:00:00' end_time: '16:00:00' local_end_time: '18:00:00' timezone: Europe/Berlin weekday: 1 quota: null - type: schedules id: '4838' attributes: start_time: '07:00:00' local_start_time: '09:00:00' end_time: '16:00:00' local_end_time: '18:00:00' timezone: Europe/Berlin weekday: 2 quota: null - type: schedules id: '4839' attributes: start_time: '07:00:00' local_start_time: '09:00:00' end_time: '16:00:00' local_end_time: '18:00:00' timezone: Europe/Berlin weekday: 3 quota: null - type: schedules id: '4840' attributes: start_time: '07:00:00' local_start_time: '09:00:00' end_time: '16:00:00' local_end_time: '18:00:00' timezone: Europe/Berlin weekday: 4 quota: null - type: schedules id: '4841' attributes: start_time: '07:00:00' local_start_time: '09:00:00' end_time: '16:00:00' local_end_time: '18:00:00' timezone: Europe/Berlin weekday: 5 quota: null - type: services id: '1016' attributes: name: Flex Day Pass slug: jl2rvfpq0y9afbww3oyavybnrifmbk description: null hidden: false is_rental_option: true has_flexible_duration: false auto_duration: false allow_cross_schedule: false allow_end_off_schedule: false requires_booking_description: false requires_address: true is_online: false requires_mobile: false allow_customer_notes: false allow_more_bookings: true charge_off_schedule: true booking_interval: 1 auto_calculate_booking_interval: true calculation_interval: 1 min_duration: 1 max_duration: 1 uncharged_duration: 0 is_full_day: false lead_time: 0 padding_before: 0 padding_after: 0 advance_booking_period: 365 price: 25 starting_fee: 0 currency: EUR tax_rate: 19 is_net_price: true price_hidden: false allow_personalization: false require_personalization: false require_address_personalization: false default_weight: 1 created_at: '2023-03-24T15:01:36+00:00' updated_at: '2023-03-24T15:14:23+00:00' access_code: null anonymous_email: false price_label: null has_custom_schedules: false public_settings: cancellation: period: before_booking_start offset: 0 unit: day quota: null relationships: add_ons: data: [] service_sub_resources: data: [] cancellation_policy: data: null group: data: null meta: resource_list: Flex Desks min_duration_total: 25 viewing_restricted: false booking_restricted: false - type: communities id: sot-flex-H5y9NsEC attributes: slug: sot-flex-H5y9NsEC name: SOT Flex color: var(--secondary-color) icon: building welcome_text: null is_private: true allow_customer_requests: false allow_organization_requests: false relationships: logo_image: [] resources: [] resource_groups: [] services: [] organizations: [] meta: [] '404': description: Not Found security: [] components: schemas: resources.v1: $schema: https://json-schema.org/draft/2020-12/schema x-version: 1.1.0 title: Resource type: object description: >- A bookable resource (room, person, equipment, etc.) organized in a nested tree structure. x-tags: - Models properties: id: type: string type: type: string default: resources attributes: type: object properties: name: type: string description: Resource name local_name: type: string description: Localized name slug: type: string description: URL-friendly slug description: type: - string - 'null' description: Rich text description plain_description: type: - string - 'null' description: Plain text description email_info: type: - string - 'null' description: Email info text x-visibility: admin color: type: - string - 'null' description: Display color hex code color_map: type: object description: Color palette map icon: type: - string - 'null' description: Icon identifier quantity: type: integer description: Number of parallel bookable slots max_booking_quantity: type: integer description: Max bookings per order max_sequence_quantity: type: integer description: Max slots in a sequence exclusive_slots: type: boolean description: Whether slots are exclusive timezone: type: string description: IANA timezone latitude: type: - number - 'null' description: Latitude coordinate longitude: type: - number - 'null' description: Longitude coordinate availability_mode: type: string description: How availability is calculated online_resource: type: boolean description: Whether this is a virtual resource bookings_enabled: type: boolean description: Whether bookings are enabled requires_quota: type: boolean description: Whether a quota is required to book level: type: integer readOnly: true description: Nesting level in resource tree archived: type: boolean description: Whether the resource is archived x-visibility: admin live: type: boolean description: Whether the resource is live/published x-visibility: admin public_listing: type: boolean description: Listed in public directory x-visibility: admin hidden: type: boolean description: Whether hidden from listing x-visibility: admin display_public_description: type: boolean description: Show description publicly x-visibility: admin email: type: - string - 'null' description: Contact email x-visibility: admin preview_token: type: string description: Token for preview access x-visibility: admin settings: type: object description: Resource settings x-visibility: admin created_at: type: string description: Creation timestamp x-visibility: admin links: $ref: '#/components/schemas/links.v1' relationships: type: object properties: organization: type: object description: Owning organization properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' parent: type: object description: Parent resource in tree properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' children: type: object description: Child resources properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' category: type: object description: Resource category properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' location: type: object description: Location resource properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' 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' logo_image: type: object description: Logo image properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' gallery_images: type: object description: Gallery images properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' services: type: object description: Available services properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' schedules: type: object description: Schedules properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' resource_groups: type: object description: Group memberships properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' resource_properties: type: object description: Property assignments properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' featured_properties: type: object description: Featured properties properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' external_calendars: type: object description: Synced external calendars properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' communities: type: object description: Associated communities properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' files: type: object description: Attached files properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' resource_maps: type: object description: Map assignments properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' meta: type: object properties: minimal_service: type: object description: Minimal service data for display 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 ````