# Bardge API (V3)

## Docs
- [Introduction](https://docs.bardge.com/introduction-2134721m0.md): 
- [Authentication](https://docs.bardge.com/authentication-2134722m0.md): 
- [Errors](https://docs.bardge.com/errors-2134723m0.md): 
- [Idempotent Requests](https://docs.bardge.com/idempotent-requests-2134725m0.md): 
- [Pagination](https://docs.bardge.com/pagination-2134726m0.md): 
- Passes [Introduction](https://docs.bardge.com/introduction-2154624m0.md): 
- Providers [Introduction](https://docs.bardge.com/introduction-2154625m0.md): 
- Access Codes [Introduction](https://docs.bardge.com/introduction-2154626m0.md): 
- Bookings [Introduction](https://docs.bardge.com/introduction-2154627m0.md): 
- Co-pay [Introduction](https://docs.bardge.com/introduction-2154628m0.md): 
- Credits [Introduction](https://docs.bardge.com/introduction-2154629m0.md): 
- Lookup [Introduction](https://docs.bardge.com/introduction-2154633m0.md): 

## API Docs
- Passes [Get All Reseller Passes](https://docs.bardge.com/get-all-reseller-passes-35696621e0.md): Returns a paginated list of all pass packages available to your business account. To find out whether your clients are on a pay-as-you-go or prepaid pass, reach out to your business relationship manager.
- Passes [Issue a pass](https://docs.bardge.com/issue-a-pass-35696618e0.md): Creates a new client record and issues a pass to that client.
- Passes [Update user's pass](https://docs.bardge.com/update-users-pass-35696620e0.md): Updates the pass type on the active issued pass for a client. Idempotent — supply Idempotency-Key to safely retry.
- Passes [Update user's pass expiry](https://docs.bardge.com/update-users-pass-expiry-35696619e0.md): Extends or updates the expiry date on the active issued pass for a client. Idempotent — supply Idempotency-Key to safely retry.
- Passes [Get User Pass Details](https://docs.bardge.com/get-user-pass-details-35696622e0.md): Retrieves the active issued pass for a given client
- Providers [Get providers](https://docs.bardge.com/get-providers-35696633e0.md): Returns a paginated list of wellness providers, optionally filtered by category and geographic proximity.
- Providers [Get providers for a pass](https://docs.bardge.com/get-providers-for-a-pass-35696634e0.md): Returns all providers that offer a given pass, optionally filtered by geographic proximity.
- Access Codes [Generate dynamic access code](https://docs.bardge.com/generate-dynamic-access-code-35696632e0.md): Generates a dynamic access code and QR code for a client. Supply either pass_code or client_id (at least one required).
- Bookings [Get class categories](https://docs.bardge.com/get-class-categories-36062962e0.md): Returns all active class categories. Use the `name` field as the `category` filter value when calling GET /classes.
- Bookings [Get classes](https://docs.bardge.com/get-classes-35696629e0.md): Returns a paginated list of group fitness classes, optionally filtered by category, date, and geographic proximity.
- Bookings [Get class with instances](https://docs.bardge.com/get-class-with-instances-35696630e0.md): Returns a class and all its upcoming scheduled instances.
- Bookings [Initiate a class booking](https://docs.bardge.com/initiate-a-class-booking-35696627e0.md): Validates eligibility for the requested class and returns one of three outcomes:
- Bookings [Confirm a class booking](https://docs.bardge.com/confirm-a-class-booking-36247106e0.md): Completes a booking session returned by POST /bookings/class. The required fields depend on the session type:
- Bookings [Initiate a spa booking](https://docs.bardge.com/initiate-a-spa-booking-35696626e0.md): Validates eligibility for the requested services and checks whether a co-pay is required. If no co-pay is needed the booking is created immediately and the response contains the booking details. If a co-pay is required a booking session is returned — collect the co-pay from the client then call POST /bookings/spa/{sessionId}/confirm to complete the booking. Sessions expire after 24 hours. Idempotent — supply Idempotency-Key to safely retry. Alternatively, supply Bardge-Lookup-Token to initiate on behalf of a looked-up client without API key authentication.
- Bookings [Confirm a spa booking](https://docs.bardge.com/confirm-a-spa-booking-36125967e0.md): Completes a booking session returned by POST /bookings/spa when a co-pay was required. Call this after the business has collected the co-pay from the client. The business account is debited and the booking is created atomically. If the session has expired (24-hour window), call POST /bookings/spa again to start a new session. Idempotent — supply Idempotency-Key to safely retry.
- Bookings [Get client bookings](https://docs.bardge.com/get-client-bookings-35696628e0.md): Returns a paginated list of bookings for a specific client, optionally filtered by status and type.
- Bookings [Get booking status](https://docs.bardge.com/get-booking-status-35696631e0.md): Returns the current status of a booking.
- Bookings [Cancel a booking](https://docs.bardge.com/cancel-a-booking-35696625e0.md): Cancels a booking. Works for both spa and class bookings. Credits are refunded based on the provider's cancellation policy.
- Credits [Purchase credits](https://docs.bardge.com/purchase-credits-35696623e0.md): Purchases a credit package for a client. Idempotent — supply Idempotency-Key to safely retry.
- Credits [Get credit packages](https://docs.bardge.com/get-credit-packages-35696624e0.md): Returns a paginated list of available credit packages that clients can purchase.
- Lookup [Get issuers](https://docs.bardge.com/get-issuers-35696615e0.md): Returns a list of resellers that have enabled third-party lookup. Use the returned issuer ID when initiating a lookup.
- Lookup [Initiate a lookup](https://docs.bardge.com/initiate-a-lookup-35696613e0.md): Initiates a third-party client lookup. Bardge validates the issuer and client, sends the client's access code to them via email, and returns a pending lookup record.
- Lookup [Verify a lookup](https://docs.bardge.com/verify-a-lookup-35696614e0.md): Verifies the access code the client shared back. On success, marks the lookup as active and returns a lookup token valid until the client's pass expires. Store this token on your own system after verification and reuse it later when generating access codes for the looked-up client.
- Lookup [Get a client](https://docs.bardge.com/get-a-client-35696616e0.md): Retrieves a client record by its Bardge client ID.
- Lookup [Get client credits](https://docs.bardge.com/get-client-credits-35696617e0.md): Returns the credit balance and recent transaction history for a client.

## Schemas
- [PasscodeV3Request](https://docs.bardge.com/passcodev3request-14801868d0.md): 
- [PurchaseSpaCoPayV3Request](https://docs.bardge.com/purchasespacopayv3request-14915843d0.md): 
- [LookupInitiateV3Request](https://docs.bardge.com/lookupinitiatev3request-14932020d0.md): 
- [ResellerV3PasscodeResponse](https://docs.bardge.com/resellerv3passcoderesponse-14801869d0.md): 
- [ErrorDetail](https://docs.bardge.com/errordetail-14801870d0.md): 
- [ResellerV3ErrorResponse](https://docs.bardge.com/resellerv3errorresponse-14801871d0.md): 
- [LookupV3Response](https://docs.bardge.com/lookupv3response-14932021d0.md): 
- [ResellerV3SpaCoPayPurchaseResponse](https://docs.bardge.com/resellerv3spacopaypurchaseresponse-14915844d0.md): 
- [LookupVerifyV3Request](https://docs.bardge.com/lookupverifyv3request-14932022d0.md): 
- [SpaCoPayQuoteV3Request](https://docs.bardge.com/spacopayquotev3request-14915845d0.md): 
- [IssuePassV3Request](https://docs.bardge.com/issuepassv3request-14801872d0.md): 
- [PassRef](https://docs.bardge.com/passref-14801873d0.md): 
- [ResellerV3SpaCoPayQuoteResponse](https://docs.bardge.com/resellerv3spacopayquoteresponse-14915846d0.md): 
- [CategoryDetails](https://docs.bardge.com/categorydetails-14836056d0.md): 
- [ResellerV3IssuedPassResponse](https://docs.bardge.com/resellerv3issuedpassresponse-14801874d0.md): 
- [UpdateIssuedPassExpiryV3Request](https://docs.bardge.com/updateissuedpassexpiryv3request-14801876d0.md): 
- [ResellerV3IssuedPassMessageResponse](https://docs.bardge.com/resellerv3issuedpassmessageresponse-14915847d0.md): 
- [UpdateLookupEnabledRequest](https://docs.bardge.com/updatelookupenabledrequest-14932023d0.md): 
- [UpdateIssuedPassV3Request](https://docs.bardge.com/updateissuedpassv3request-14801875d0.md): 
- [PurchaseGymCoPayV3Request](https://docs.bardge.com/purchasegymcopayv3request-14915848d0.md): 
- [PurchaseCoPayPackageV3Request](https://docs.bardge.com/purchasecopaypackagev3request-14801879d0.md): 
- [PurchaseCreditsV3Request](https://docs.bardge.com/purchasecreditsv3request-14801877d0.md): 
- [ResellerV3GymCoPayPurchaseResponse](https://docs.bardge.com/resellerv3gymcopaypurchaseresponse-14998778d0.md): 
- [ResellerV3CreditPurchaseResponse](https://docs.bardge.com/resellerv3creditpurchaseresponse-14801878d0.md): 
- [ResellerV3CoPayPurchaseResponse](https://docs.bardge.com/resellerv3copaypurchaseresponse-14801880d0.md): 
- [RescheduleBookingV3Request](https://docs.bardge.com/reschedulebookingv3request-14801881d0.md): 
- [RefundInfo](https://docs.bardge.com/refundinfo-14801883d0.md): 
- [PasscodeInfo](https://docs.bardge.com/passcodeinfo-14801882d0.md): 
- [ResellerV3BookingResponse](https://docs.bardge.com/resellerv3bookingresponse-14801884d0.md): 
- [BookSpaV3Request](https://docs.bardge.com/bookspav3request-14801885d0.md): 
- [ResellerV3SpaBookingInitiateResponse](https://docs.bardge.com/resellerv3spabookinginitiateresponse-15084706d0.md): 
- [BookClassV3Request](https://docs.bardge.com/bookclassv3request-14801886d0.md): 
- [CopayOption](https://docs.bardge.com/copayoption-15114373d0.md): 
- [ResellerV3ProviderResponse](https://docs.bardge.com/resellerv3providerresponse-14836057d0.md): 
- [ResellerV3ClassBookingInitiateResponse](https://docs.bardge.com/resellerv3classbookinginitiateresponse-15114374d0.md): 
- [ResellerV3ServiceResponse](https://docs.bardge.com/resellerv3serviceresponse-14801888d0.md): 
- [ConfirmClassBookingV3Request](https://docs.bardge.com/confirmclassbookingv3request-15114375d0.md): 
- [ResellerV3SpaResponse](https://docs.bardge.com/resellerv3sparesponse-14801889d0.md): 
- [AccessCodeV3Request](https://docs.bardge.com/accesscodev3request-14915849d0.md): 
- [ServicePreview](https://docs.bardge.com/servicepreview-14801890d0.md): 
- [ResellerV3AccessCodeResponse](https://docs.bardge.com/resellerv3accesscoderesponse-14915850d0.md): 
- [ResellerV3ListResponse](https://docs.bardge.com/resellerv3listresponse-14801887d0.md): 
- [ResellerV3AccessCodeSessionResponse](https://docs.bardge.com/resellerv3accesscodesessionresponse-15125908d0.md): 
- [ResellerV3AvailabilityResponse](https://docs.bardge.com/resellerv3availabilityresponse-14801891d0.md): 
- [ConfirmAccessCodeV3Request](https://docs.bardge.com/confirmaccesscodev3request-15125909d0.md): 
- [ResellerV3ClientResponse](https://docs.bardge.com/resellerv3clientresponse-14801894d0.md): 
- [CategoryDetail](https://docs.bardge.com/categorydetail-14801892d0.md): 
- [ResellerV3CreditsResponse](https://docs.bardge.com/resellerv3creditsresponse-14801895d0.md): 
- [ResellerV3PassResponse](https://docs.bardge.com/resellerv3passresponse-14801893d0.md): 
- [ResellerV3ClassInstanceResponse](https://docs.bardge.com/resellerv3classinstanceresponse-14801896d0.md): 
- [ResellerV3ClassResponse](https://docs.bardge.com/resellerv3classresponse-14801897d0.md): 
- [ResellerV3BookingStatusResponse](https://docs.bardge.com/resellerv3bookingstatusresponse-14801898d0.md):