> ## 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 an organization ## OpenAPI ````yaml /developers/openapi/customer.openapi.json get /api/v1/organizations/{organization_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/organizations/{organization_slug}: parameters: - schema: type: string name: organization_slug in: path required: true get: tags: - Organizations summary: Get an organization operationId: get-organizations-record parameters: - schema: type: string enum: - cover_image - logo_image - legal_documents - industry - resource_groups - location - addresses - offered_plans example: logo_image,cover_image,location,resource_groups,offered_plans in: query name: include description: Allows to include allowed resources in the response - schema: type: string enum: - name - official_name in: query name: sort - name: filter[search] in: query schema: type: string responses: '200': description: OK content: application/vnd.api+json: schema: type: object properties: data: $ref: '#/components/schemas/organizations.v1' examples: Full Example: value: data: 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: location: data: type: addresses id: '28538' cover_image: data: type: images id: '1657' logo_image: data: type: images id: '1647' resource_groups: data: [] offered_plans: data: - type: plans id: online-membership - type: plans id: basic-membership - type: plans id: premium-membership - type: plans id: private-office - type: plans id: fitness-membership links: self: https://b.staging.anny.co/api/v1/organizations/281 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 included: - 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: '1657' attributes: url: >- https://cdn.staging.booking-buddy.de/public/images/images/original/aPe4BclXecer6zbrnMtBTGWId.jpg copyright: null width: '1920' height: '1440' order_index: '0' preview_image_base64: null small_path: >- https://cdn.staging.booking-buddy.de/public/images/images/original/aPe4BclXecer6zbrnMtBTGWId.jpg medium_path: >- https://cdn.staging.booking-buddy.de/public/images/images/original/aPe4BclXecer6zbrnMtBTGWId.jpg large_path: >- https://cdn.staging.booking-buddy.de/public/images/images/original/aPe4BclXecer6zbrnMtBTGWId.jpg created_at: '2023-03-24T15:28:55+00:00' - 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: plans id: online-membership attributes: name: Online Membership description:

For remote workers

illustration_path: null feature_group: null public: true color: null badge: null original_price: null effective_price: 25 price: 25 tax_rate: 19 display_price: null price_disclaimer: '' is_net_price: false signup_fee: 0 currency: EUR trial_period: 0 trial_interval: day invoice_period: 1 invoice_interval: month sort_order: 0 allow_switching: true auto_renewal: true is_billable_offline: false payment_fee_absolute: 0 payment_fee_relative: 0 request_pricing: false request_pricing_url: null requires_approval: true minimum_term: 1 notice_period: 0 - type: plans id: basic-membership attributes: name: Basic Membership description: '' illustration_path: null feature_group: null public: true color: null badge: BEST FOR STARTUPS original_price: 200 effective_price: 150 price: 150 tax_rate: 19 display_price: null price_disclaimer: '' is_net_price: true signup_fee: 0 currency: EUR trial_period: 7 trial_interval: day invoice_period: 1 invoice_interval: month sort_order: 1 allow_switching: true auto_renewal: true is_billable_offline: false payment_fee_absolute: 0 payment_fee_relative: 0 request_pricing: false request_pricing_url: null requires_approval: false minimum_term: 1 notice_period: 0 - type: plans id: premium-membership attributes: name: Premium Membership description: '' illustration_path: null feature_group: null public: true color: null badge: null original_price: null effective_price: 300 price: 300 tax_rate: 19 display_price: null price_disclaimer: '' is_net_price: true signup_fee: 0 currency: EUR trial_period: 0 trial_interval: day invoice_period: 1 invoice_interval: month sort_order: 2 allow_switching: true auto_renewal: true is_billable_offline: false payment_fee_absolute: 0 payment_fee_relative: 0 request_pricing: false request_pricing_url: null requires_approval: true minimum_term: 3 notice_period: 0 - type: plans id: private-office attributes: name: Private Office description: '' illustration_path: null feature_group: null public: true color: null badge: null original_price: null effective_price: 10000 price: 10000 tax_rate: 19 display_price: null price_disclaimer: '' is_net_price: false signup_fee: 0 currency: EUR trial_period: 0 trial_interval: day invoice_period: 1 invoice_interval: year sort_order: 3 allow_switching: true auto_renewal: true is_billable_offline: false payment_fee_absolute: 0 payment_fee_relative: 0 request_pricing: false request_pricing_url: null requires_approval: true minimum_term: 1 notice_period: 0 - type: plans id: fitness-membership attributes: name: Fitness Membership description: '' illustration_path: null feature_group: null public: true color: '#d33e8a' badge: null original_price: null effective_price: 50 price: 50 tax_rate: 19 display_price: null price_disclaimer: '' is_net_price: false signup_fee: 0 currency: EUR trial_period: 0 trial_interval: day invoice_period: 1 invoice_interval: month sort_order: 1 allow_switching: true auto_renewal: true is_billable_offline: false payment_fee_absolute: 0 payment_fee_relative: 0 request_pricing: false request_pricing_url: null requires_approval: false minimum_term: 1 notice_period: 0 '404': description: Not Found security: [] components: schemas: organizations.v1: $schema: https://json-schema.org/draft/2020-12/schema x-version: 1.1.0 title: Organization type: object description: >- A tenant organization that owns resources, services, and manages bookings. x-tags: - Models properties: id: type: string type: type: string default: organizations attributes: type: object properties: slug: type: string description: URL-friendly slug name: type: string description: Display name official_name: type: string description: Legal/official name description: type: - string - 'null' description: Rich text description plain_description: type: - string - 'null' description: Plain text description support_email: type: - string - 'null' description: Support email phone: type: - string - 'null' description: Phone number currency: type: string description: ISO 4217 currency code timezone: type: string description: IANA timezone country_code: type: - string - 'null' description: ISO country code region: type: - string - 'null' description: Region uses_payments: type: boolean description: Whether online payments are enabled automated_invoicing: type: boolean description: Whether invoicing is automated is_organization: type: boolean description: Is registered organization (vs individual) default_locale: type: string description: Default locale live: type: boolean description: Whether published features: type: object description: Feature flags preview_token: type: string description: Preview access token x-visibility: admin setup_completed: type: boolean description: Whether setup wizard is complete x-visibility: admin requires_subscription: type: boolean description: Whether a subscription is required billing_address: type: object description: Billing address x-visibility: admin billing_email: type: string description: Billing email x-visibility: admin custom_styles: type: object description: Custom CSS/style overrides x-visibility: admin responsible_for_contents: type: string description: Legal responsible person ceo: type: - string - 'null' description: CEO name vat_id: type: - string - 'null' description: VAT ID register_number: type: - string - 'null' description: Register number local_court: type: - string - 'null' description: Local court financial_office: type: - string - 'null' description: Financial office email_info: type: - string - 'null' description: Email footer info created_at: type: string description: Creation timestamp links: $ref: '#/components/schemas/links.v1' relationships: type: object properties: industry: type: object description: Industry classification properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' addresses: type: object description: Organization addresses properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' resources: type: object description: All resources properties: data: type: array items: type: object 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' negative_logo_image: type: object description: Negative/inverted logo properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' organization_users: type: object description: Team members properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' legal_documents: type: object description: Legal documents properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' bank_accounts: type: object description: Bank accounts properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' resource_groups: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Resource groups integrations: type: object description: Active integrations properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' location: type: object description: Primary location resource properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' main_subscription: type: object description: Main platform subscription properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' payment_account: type: object description: Payment provider account 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 ````