> ## 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.

# Get a booking

> Returns the current state of a booking (including payment status) by its 1Club id.



## OpenAPI

````yaml /openapi-platform.json get /v1/platform/bookings/{id}
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.


    ## 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.


    ## Rate Limiting


    - **100 requests per minute** per organization

    - 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 |

    | `403` | API key is missing the required scope |

    | `404` | Resource not found (or doesn't belong to your organization) |

    | `429` | Rate limit exceeded |

    | `500` | Internal server error |
  contact:
    name: 1Club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags:
  - name: Classes
    description: Browse class schedules, pricing, and availability.
  - name: Content
    description: Read published content (FAQs, posts, documents, blocks).
  - name: Clubs
    description: Look up club details by slug.
  - name: Transactions
    description: List and inspect billing transactions.
  - name: Bookings
  - name: Areas
paths:
  /v1/platform/bookings/{id}:
    get:
      tags:
        - Bookings
      summary: Get a booking
      description: >-
        Returns the current state of a booking (including payment status) by its
        1Club id.
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
          description: 1Club booking id
      responses:
        '200':
          description: Booking state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformBooking'
        '400':
          description: Invalid booking id
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '403':
          description: API key is missing the required `bookings:read` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '404':
          description: Booking not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
      security:
        - customerApiAuth: []
components:
  schemas:
    PlatformBooking:
      type: object
      description: >-
        A booking created through the platform API. Recorded with a booking
        transaction so it counts for revenue, marked paid (settled against the
        External / API payment method) or unpaid (outstanding) per the caller.
        Refunds and collection stay with the caller.
      properties:
        bookingId:
          type: integer
          description: 1Club booking id
        status:
          type: string
          description: Booking status (e.g. confirmed, cancelled)
        areaId:
          type: integer
          nullable: true
          description: Area id
        startTime:
          type: string
          format: date-time
        endTime:
          type: string
          format: date-time
        payment:
          type: object
          properties:
            status:
              type: string
              enum:
                - paid
                - unpaid
            amount:
              type: number
              nullable: true
              description: Recorded amount in the organization's currency
    PlatformError:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    customerApiAuth:
      type: http
      scheme: bearer
      description: Customer API key obtained from the admin portal (e.g. 1club_sk_live_...)

````