> ## Documentation Index > Fetch the complete documentation index at: https://docs.1club.ai/llms.txt > Use this file to discover all available pages before exploring further. # Check in a booking or a member > Records attendance, in one of two ways. Send exactly one of `bookingId` or `contactId`. Supports the `Idempotency-Key` header. **An existing booking** (`bookingId`): records attendance for the booking during its configured check-in window. The booking must be `confirmed` or `pending`, and its payment and duplicate-attendance rules still apply. **A visit with no booking** (`contactId` and `clubId`): checks a member in at the club on their membership, the way the front desk's direct check-in does, and spends one session from it. Name the membership with `membershipId`, or leave it out to use the member's own covering membership (one with nothing owed is preferred). To record the visit against a zero-fee external program instead, send `externalProgramId`. The membership must not be limited to particular classes, areas or instructors, must have sessions left, and must have nothing owed on it - a member who owes is checked in at the front desk, where staff can see the balance. Nothing is charged. To check someone into a class or an area, book it first and check that booking in. ## OpenAPI ````yaml /openapi-platform.json post /v1/platform/checkins openapi: 3.0.0 info: title: 1club Platform API version: 1.0.0 description: >- The 1club Platform API lets you programmatically access and manage your organization's data. ## Official API Contract This documentation is the official source of truth for the 1club Platform API. If an integration relies on undocumented endpoints, fields, response shapes, or internal behavior outside this spec, we can't guarantee backward compatibility. Build against what's documented here to stay stable as the platform evolves. ## Authentication All requests require a customer API key passed as a Bearer token: ``` Authorization: Bearer 1club_sk_live_... ``` Generate API keys from the admin portal under **Settings > API Tokens**. The key is tied to your organization - all responses are scoped to your org's data. Agents and MCP connectors can instead send an OAuth access token (the `platformOAuth` scheme), requesting only the scopes the task needs. ## Rate Limiting - **100 requests per minute** per API key - When exceeded, the API returns `429 Too Many Requests` with a `Retry-After` header - Rate limit headers are included in every response: - `X-RateLimit-Limit` - max requests per window - `X-RateLimit-Remaining` - requests remaining - `X-RateLimit-Reset` - seconds until the window resets ## Errors | Status | Meaning | |--------|---------| | `400` | Invalid request parameters | | `401` | Missing or invalid API key | | `404` | Resource not found (or doesn't belong to your organization) | | `429` | Rate limit exceeded | | `500` | Internal server error | ## Versioning and deprecation The API is versioned in the path (`/v1`). Changes within a version are additive: new endpoints, new optional parameters and new response fields can appear at any time, so clients should ignore fields they do not recognise. A breaking change ships as a new version. An operation due to be removed is first marked `deprecated: true` in this spec and announced in the changelog at https://docs.1club.ai/changelog, with advance notice before it is withdrawn. contact: name: 1club API Support email: support@1club.ai servers: - url: https://api.1club.ai description: Production API security: - customerApiAuth: [] - platformOAuth: [] tags: [] paths: /v1/platform/checkins: post: tags: - Check-ins summary: Check in a booking or a member description: > Records attendance, in one of two ways. Send exactly one of `bookingId` or `contactId`. Supports the `Idempotency-Key` header. **An existing booking** (`bookingId`): records attendance for the booking during its configured check-in window. The booking must be `confirmed` or `pending`, and its payment and duplicate-attendance rules still apply. **A visit with no booking** (`contactId` and `clubId`): checks a member in at the club on their membership, the way the front desk's direct check-in does, and spends one session from it. Name the membership with `membershipId`, or leave it out to use the member's own covering membership (one with nothing owed is preferred). To record the visit against a zero-fee external program instead, send `externalProgramId`. The membership must not be limited to particular classes, areas or instructors, must have sessions left, and must have nothing owed on it - a member who owes is checked in at the front desk, where staff can see the balance. Nothing is charged. To check someone into a class or an area, book it first and check that booking in. operationId: createCheckin parameters: - in: header name: Idempotency-Key schema: type: string maxLength: 255 description: >- Retry-safe key; a repeat of the same request replays the first response requestBody: required: true content: application/json: schema: oneOf: - type: object title: Booking check-in required: - bookingId properties: bookingId: type: integer clubId: type: integer description: >- Required only for a clubless event booking when no club can otherwise be derived. Must belong to the authorized organization. - type: object title: Check-in without a booking required: - contactId - clubId additionalProperties: false properties: contactId: type: integer description: The member checking in clubId: type: integer description: >- The club they are checking in at. Must belong to the authorized organization. membershipId: type: integer description: >- The membership to spend the visit from. Omit to use the member's own covering membership. externalProgramId: type: integer description: >- A zero-fee external program to record the visit against instead of a membership. At most one of membershipId and externalProgramId. responses: '201': description: Check-in created content: application/json: schema: $ref: '#/components/schemas/PlatformCheckin' '400': description: >- The body names both or neither of `bookingId` and `contactId`; the booking is not `confirmed` or `pending` or has an unpaid balance; `clubId` is missing or not in this organization; or the membership is not one a visit without a booking can use (`MEMBERSHIP_NOT_ELIGIBLE`), owes money (`MEMBERSHIP_UNPAID`), or the member has none (`NO_COVERING_MEMBERSHIP`) '403': description: >- Missing `checkins:write` scope or check-in is outside the allowed window '404': $ref: '#/components/responses/PlatformNotFound' '409': description: Booking is already checked in security: - customerApiAuth: [] components: schemas: PlatformCheckin: type: object description: >- An attendance record for a booking, class, membership, or direct gym visit. properties: checkinId: type: integer contactId: type: integer nullable: true clubId: type: integer classId: type: integer nullable: true bookingId: type: integer nullable: true membershipId: type: integer nullable: true externalProgramId: type: integer nullable: true entranceMethod: type: string nullable: true date: type: string format: date-time createdAt: type: string format: date-time contact: type: object nullable: true additionalProperties: true club: type: object additionalProperties: true class: type: object nullable: true additionalProperties: true booking: type: object nullable: true additionalProperties: true membership: type: object nullable: true additionalProperties: true externalProgram: type: object nullable: true additionalProperties: true PlatformError: type: object properties: error: type: string code: type: string description: >- A stable, machine-readable reason, when the error has one (e.g. `CONTACT_EXISTS`). details: type: object additionalProperties: true description: >- Structured values behind the error. A 409 naming an existing record carries its id here, e.g. `contactId`. responses: PlatformNotFound: description: The requested resource does not exist in this organization content: application/json: schema: $ref: '#/components/schemas/PlatformError' securitySchemes: customerApiAuth: type: http scheme: bearer description: >- Organization-scoped bearer credential: a customer API key (1club_sk_live_...) or an MCP OAuth access token. platformOAuth: type: oauth2 description: >- OAuth 2.1 authorization code flow with PKCE (S256), as used by MCP connectors. Register a client dynamically (RFC 7591) at https://api.1club.ai/v1/mcp/oauth/register. Each scope grants one capability; request only what the integration needs. flows: authorizationCode: authorizationUrl: https://auth.1club.ai/oauth/authorize tokenUrl: https://api.1club.ai/v1/mcp/oauth/token scopes: '*': >- Full access - read and manage everything in this organization, including capabilities added later classes:read: View classes, class types, schedules and progression tracks classes:write: >- Create, reschedule, and cancel classes, and maintain the class types they are run as checkins:read: View check-ins checkins:write: Check people in, to a booking or on their membership content:read: View published content content:write: >- Create, edit and delete content - posts, FAQs, documents and reusable blocks website:read: >- View your website: pages, sections, layout, styles and publish history website:write: >- Edit your website - pages, sections, navigation and styles. Edits stay unpublished until published. website:publish: >- Publish your website, making unpublished edits visible to the public, and roll back to an earlier version media:read: View your media library media:write: >- Add images and videos to your media library and edit their names and descriptions media:delete: Permanently delete files from your media library clubs:read: View club information clubs:write: >- Edit your clubs' details - name, contact details, address, opening hours, amenities and sports. Live on your website, member portal, app and 1club.me at once; a club listed on 1club.me sends its listing's changes for review. transactions:read: View transactions, revenue reports and your chart of accounts transactions:write: >- Record revenue collected outside 1club, such as a marketplace payout for your bookings, and refunds of it. Nothing is charged to anyone. invoices:read: >- View your invoices - who they were issued to, their amounts and status - and how much was invoiced over a period areas:read: View areas, area types, blocks and availability areas:write: >- Create and update areas and area types, and block or unblock an area bookings:read: View bookings bookings:write: >- Create, change, reschedule and cancel bookings, and add or remove participants contacts:read: >- View contacts, their tags and custom field values, and your sales pipeline stages and sources contacts:write: >- Create and update contacts and tag them, and maintain your tags, smart tag rules and contact custom fields contacts:delete: >- Archive contacts, which cancels their active memberships and all their future bookings. Separate from creating and updating because those cancellations are not undone by restoring the contact. instructors:read: View instructors and their availability instructors:write: >- Create and update instructors (coaches) and the instructor types they are grouped by, including what members pay for a one-to-one session and how you pay the coach. Does not grant admin-portal access: an instructor created this way has no login and is never invited to your staff portal. plans:read: View plans and pricing plans:write: Create, edit and delete plans and plan categories memberships:read: View memberships memberships:write: >- Sell memberships, set their price and whether they are paid, and pause, resume or cancel them products:read: >- View the product catalogue and its categories, including prices and how many are left to sell products:write: Create and edit products and product categories forms:read: >- View your forms and their questions, and how many people have completed each. Not the answers themselves. forms:write: >- Create and edit forms and their questions, including sign-up forms that sell your plans and products. Forms are public as soon as they are created or changed. Does not delete forms. organization:write: >- Change organization-wide settings, which take effect immediately. That includes which languages you offer, across your website, the member portal, the mobile app and email, and what your clubs call their booking cards (private training, group activities, areas) wherever members book. revenue-accounts:write: >- Add accounts to your chart of accounts and edit them, including which one sales post to by default. Reading the chart needs no scope of its own - any of plans, products or transactions admits it. pricing-rules:read: >- View pricing rules - the surcharges, discounts and set prices applied when a booking is priced - and quote what a booking would cost pricing-rules:write: >- Create, edit, turn off and delete pricing rules. Changes apply to every booking priced afterwards. booking-policies:read: >- View booking policies: cancellation and refund rules, payment timing and booking windows booking-policies:write: >- Create, edit, duplicate and delete booking policies. Changes apply to every booking they cover from then on. document-rules:read: >- View document rules - which members are asked to sign or accept which documents, such as waivers document-rules:write: >- Create, edit and delete document rules, which decide who must sign or accept a document and whether it is required for entry templates:read: View your email and SMS templates templates:write: Create, edit and delete email and SMS templates events:read: View events, their tickets and how many are sold events:write: >- Create, edit, duplicate and delete events, and publish, unpublish or cancel them. Cancelling an event also cancels its attendees' bookings. messages:read: >- View messages sent to and received from your members, and their delivery status messages:write: >- Prepare draft messages to members. Drafts are never sent from here: someone at your club reviews and sends them from 1club. analytics:read: >- View statistics over a period - revenue, bookings, check-ins, how full your classes, courts and coaches were, memberships added and cancelled, and new members - as totals, never the people or sales behind them payment-methods:write: >- Add, rename and remove the payment methods staff record by hand, such as cash or a bank transfer, and choose which ones members may pick when paying for a booking. Reading them needs no scope of its own - transactions:read admits it. staff:read: >- View your staff accounts, their roles, and what each role is allowed to do staff:write: >- Change a staff member's role, and what the manager, front desk and instructor roles are allowed to do. Only a signed-in person can use it, with the same limits as in 1club: an API key is always refused. notifications:read: >- View which notifications each role gets by default, and on which channels notifications:write: >- Change which notifications each role gets and on which channels, and apply those defaults to everyone in a role, replacing their own choices ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.