> ## 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 community > Auth: customer. Returns a community the authenticated customer can access. ## OpenAPI ````yaml /developers/openapi/customer.openapi.json get /api/v1/communities/{community_id} 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/communities/{community_id}: get: tags: - Communities summary: Get community description: >- Auth: customer. Returns a community the authenticated customer can access. operationId: get-communities parameters: - name: community_id in: path required: true schema: type: string description: The community identifier. - name: include in: query schema: type: string description: >- Comma-separated. Allowed: domains, logo_image, resources, owner_organization, services, resource_groups responses: '200': description: OK content: application/vnd.api+json: schema: type: object properties: data: $ref: '#/components/schemas/communities.v1' '401': description: Unauthorized '403': description: Forbidden '404': description: Not Found security: - Bearer: [] components: schemas: communities.v1: $schema: https://json-schema.org/draft/2020-12/schema x-version: 1.1.0 title: Community type: object description: >- A community group for organizing members, resources, and services with access control. x-tags: - Models properties: id: type: string type: type: string default: communities attributes: type: object properties: slug: type: string description: URL-friendly slug name: type: string description: Community name color: type: string description: Display color icon: type: string description: Icon identifier welcome_text: type: - string - 'null' description: Welcome text shown to members is_private: type: boolean description: Whether community is private (invite-only) allow_customer_requests: type: boolean description: Whether customers can request to join allow_organization_requests: type: boolean description: Whether organizations can request to join auto_join_enabled: type: boolean description: Whether auto-join is enabled x-visibility: admin auto_join_settings: type: - object - 'null' description: Auto-join configuration x-visibility: admin include_all_services: type: boolean description: Whether all services are included x-visibility: admin force_incognito: type: boolean description: Force incognito mode for members default_incognito: type: boolean description: Default incognito state disable_incognito: type: boolean description: Disable incognito option default_role: type: string description: Default role assigned to new members list_resources: type: boolean description: Show resources in community list_services: type: boolean description: Show services in community default_list: type: string description: Default listing view show_blocker_title: type: boolean description: Show blocker titles to members show_booking_participants: type: boolean description: Show booking participants to members links: $ref: '#/components/schemas/links.v1' relationships: type: object properties: domains: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Community domains 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' resources: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Available resources 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 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' organizations: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Member organizations owner_organization: type: object description: Owning organization properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' community_accounts: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Member accounts unpersonalized_invite: type: object properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Public invite link booking_quotas: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Booking quotas plans: type: object properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' description: Subscription plans meta: type: object properties: members_count: type: integer description: Number of members 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: tokenUrl: https://auth.anny.co/oauth/token refreshUrl: https://auth.anny.co/oauth/token/refresh scopes: {} authorizationUrl: https://auth.anny.co/oauth/authorize ````