> ## 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 customer account information > Fetch the logged in customer identified by Bearer Token. ## OpenAPI ````yaml /developers/openapi/customer.openapi.json get /api/v1/customer-account 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/customer-account: get: tags: - Customer Accounts summary: Get current customer account description: Fetch the logged in customer identified by Bearer Token. operationId: list-customer-accounts parameters: - schema: type: string example: business_account.logo_image,business_account.primary_address enum: - addresses - primary_address - delivery_address - favorites - liked_favorites - communities - communities.external_links - profile_image - subscriptions - community_accounts - community_accounts.community - community_accounts.community.external_links - skills - account_skills.skill - booking_passes - booking_passes.booking_quota_grants - booking_passes.booking_quotas - connection_requests - connection_requests.requested_of - account_connections - account_connections.granted_to - inverse_connection_requests - inverse_connection_requests.requested_of - business_account - business_account.logo_image - business_account.primary_address format: comma-separated-list in: query name: include allowEmptyValue: true description: >- Include relations. Newly relevant for business-account bootstrap: business_account, business_account.logo_image, business_account.primary_address. responses: '200': description: OK content: application/vnd.api+json: schema: type: object properties: data: $ref: '#/components/schemas/customer-accounts.v1' examples: Example: value: data: type: customer-accounts id: 5fb1965e-66b4-4676-8b04-fbf39d57cc64 attributes: title: null sex: 0 birth_date: null given_name: Florian family_name: Schmitt email: florian.schmitt@anny.co company: null mobile: '+491741234656' mobile_verified_at: null phone: null locale: en timezone: UTC activated_at: null created_at: '2021-09-24T09:37:35.000000Z' updated_at: '2021-09-24T09:38:38.000000Z' links: self: >- https://b.anny.co/api/v1/customer-accounts/5fb1965e-66b4-4676-8b04-fbf39d57cc64 value: data: type: customer-accounts id: 19ef1b4f-9d06-4843-95aa-90f9a5ac22d5 attributes: title: Herr sex: 0 birth_date: '1997-02-18' given_name: Lucian family_name: Holtwiesche email: lucian@anny.co company: anny mobile: '+491742095775' mobile_verified_at: null phone: null locale: de timezone: Europe/Berlin activated_at: null has_organization: true created_at: '2021-11-07T15:41:40.000000Z' updated_at: '2023-03-28T22:24:53.000000Z' relationships: primary_address: data: type: addresses id: '191' liked_favorites: data: - type: favorites id: 2a8e3e7e-f774-4192-9bdd-85625d0b86e7 - type: favorites id: 4c1aee78-6ec5-4197-991b-f00dfcc8198d - type: favorites id: 81c3eda6-48b4-4406-b604-0bdb8e59b4f6 - type: favorites id: 979a84a2-2806-4330-8129-04ad5402d056 - type: favorites id: 8c402100-875c-4b3f-8481-1956db0f815c communities: data: - type: communities id: abteilung-sales-duzlS6uj - type: communities id: test-afeah4gr - type: communities id: abteilung-a-MA3ihySi - type: communities id: test-service-aHVLzVV9 - type: communities id: miglieder-woHq4gwS profile_image: data: null links: self: >- https://bookings-api-alt.test/api/v1/customer-accounts/19ef1b4f-9d06-4843-95aa-90f9a5ac22d5 meta: has_subscriptions: true included: - type: addresses id: '191' attributes: name: null street_address: Test Str. 5 zip_code: '52066' city: Aachen country_code: DE latitude: null longitude: null meta: address_line: Test Str. 5, 52066 Aachen, DE - type: favorites id: 2a8e3e7e-f774-4192-9bdd-85625d0b86e7 attributes: liked: true recent: false viewed: false model_id: '1' model_type: resources created_at: '2022-04-24T15:10:05+00:00' order_index: 0 relationships: model: links: related: >- https://bookings-api-alt.test/api/v1/favorites/2a8e3e7e-f774-4192-9bdd-85625d0b86e7/model - type: favorites id: 4c1aee78-6ec5-4197-991b-f00dfcc8198d attributes: liked: true recent: false viewed: false model_id: '22' model_type: resources created_at: '2022-04-29T21:22:52+00:00' order_index: 4 relationships: model: links: related: >- https://bookings-api-alt.test/api/v1/favorites/4c1aee78-6ec5-4197-991b-f00dfcc8198d/model - type: favorites id: 81c3eda6-48b4-4406-b604-0bdb8e59b4f6 attributes: liked: true recent: false viewed: false model_id: '41' model_type: resources created_at: '2022-05-05T14:47:21+00:00' order_index: 2 relationships: model: links: related: >- https://bookings-api-alt.test/api/v1/favorites/81c3eda6-48b4-4406-b604-0bdb8e59b4f6/model - type: favorites id: 979a84a2-2806-4330-8129-04ad5402d056 attributes: liked: true recent: false viewed: false model_id: '5' model_type: resources created_at: '2022-05-05T21:36:08+00:00' order_index: 3 relationships: model: links: related: >- https://bookings-api-alt.test/api/v1/favorites/979a84a2-2806-4330-8129-04ad5402d056/model - type: favorites id: 8c402100-875c-4b3f-8481-1956db0f815c attributes: liked: true recent: false viewed: false model_id: '42' model_type: resources created_at: '2022-05-08T19:15:18+00:00' order_index: 1 relationships: model: links: related: >- https://bookings-api-alt.test/api/v1/favorites/8c402100-875c-4b3f-8481-1956db0f815c/model - type: communities id: abteilung-sales-duzlS6uj attributes: slug: abteilung-sales-duzlS6uj name: Abteilung Sales color: '#8e5dca' icon: money-bill welcome_text: null is_private: true allow_customer_requests: false allow_organization_requests: false relationships: logo_image: [] resources: [] resource_groups: [] services: [] organizations: [] meta: [] - type: communities id: test-afeah4gr attributes: slug: test-afeah4gr name: Test 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: [] - type: communities id: abteilung-a-MA3ihySi attributes: slug: abteilung-a-MA3ihySi name: Abteilung A color: '#ed8047' icon: money-bill welcome_text: null is_private: true allow_customer_requests: false allow_organization_requests: false relationships: logo_image: [] resources: [] resource_groups: [] services: [] organizations: [] meta: [] - type: communities id: test-service-aHVLzVV9 attributes: slug: test-service-aHVLzVV9 name: Test Service 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: [] - type: communities id: miglieder-woHq4gwS attributes: slug: miglieder-woHq4gwS name: Miglieder color: var(--secondary-color) icon: address-book welcome_text: null is_private: true allow_customer_requests: false allow_organization_requests: false relationships: logo_image: [] resources: [] resource_groups: [] services: [] organizations: [] meta: [] headers: {} '401': description: Unauthorized components: schemas: customer-accounts.v1: $schema: https://json-schema.org/draft/2020-12/schema x-version: 1.1.0 title: CustomerAccount type: object description: >- An end-user account (authenticated customer) with profile and community features. x-tags: - Models properties: id: type: string type: type: string default: customeraccounts attributes: type: object properties: title: type: - string - 'null' description: Title sex: type: - string - 'null' description: Gender birth_date: type: - string - 'null' description: Date of birth given_name: type: string description: First name family_name: type: string description: Last name email: type: string description: Email address company: type: - string - 'null' description: Company name mobile: type: - string - 'null' description: Mobile number mobile_verified_at: type: - string - 'null' description: Mobile verification timestamp phone: type: - string - 'null' description: Phone number locale: type: string description: Preferred locale timezone: type: string description: IANA timezone activated_at: type: - string - 'null' description: Account activation timestamp has_organization: type: boolean description: Whether account manages an organization bio: type: - string - 'null' description: Bio text job_title: type: - string - 'null' description: Job title department: type: - string - 'null' description: Department cognitor_id: type: - string - 'null' description: Identity provider ID idp_user_id: type: - string - 'null' description: IDP user ID created_at: type: string description: Creation timestamp updated_at: type: string description: Last update timestamp links: $ref: '#/components/schemas/links.v1' relationships: type: object properties: primary_address: type: object description: Primary address properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' addresses: type: object description: All addresses properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' favorites: type: object description: Favorited resources properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' subscriptions: type: object description: Active subscriptions properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' community_accounts: type: object description: Community memberships properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' booking_passes: type: object description: Booking passes properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' booking_quota_grants: type: object description: Quota grants properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' profile_image: type: object description: Profile image properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' account_skills: type: object description: Skills properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' communities: type: object description: Communities properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' access_control_grants: type: object description: Access grants properties: data: type: array items: type: object properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' business_account: type: object description: >- Current business account membership context for the signed-in customer properties: data: type: - object - 'null' properties: type: type: string id: type: string links: $ref: '#/components/schemas/links.v1' meta: type: object properties: color: type: string description: Avatar color has_subscriptions: type: boolean description: Whether account has active subscriptions connection: type: object description: Connection info to current user upcoming_bookings: type: integer description: Count of upcoming bookings 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 ````