> ## 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 area availability

> Returns the area's operating hours and the intervals already taken by non-cancelled bookings within the window, so you can compute open slots. 1Club remains the source of truth: booking creation re-checks availability atomically and rejects conflicts.



## OpenAPI

````yaml /openapi-platform.json get /v1/platform/areas/{areaId}/availability
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/areas/{areaId}/availability:
    get:
      tags:
        - Areas
      summary: Get area availability
      description: >-
        Returns the area's operating hours and the intervals already taken by
        non-cancelled bookings within the window, so you can compute open slots.
        1Club remains the source of truth: booking creation re-checks
        availability atomically and rejects conflicts.
      parameters:
        - in: path
          name: areaId
          required: true
          schema:
            type: integer
          description: Area id
        - in: query
          name: from
          required: true
          schema:
            type: string
            format: date-time
          description: Window start (ISO date-time)
        - in: query
          name: to
          required: true
          schema:
            type: string
            format: date-time
          description: Window end (ISO date-time). At most 31 days after `from`.
      responses:
        '200':
          description: Area availability
          content:
            application/json:
              schema:
                type: object
                properties:
                  areaId:
                    type: integer
                  from:
                    type: string
                    format: date-time
                  to:
                    type: string
                    format: date-time
                  maxConcurrentBookings:
                    type: integer
                  operatingHours:
                    type: object
                    description: Per-day-of-week opening schedule
                  busy:
                    type: array
                    items:
                      type: object
                      properties:
                        startTime:
                          type: string
                          format: date-time
                        endTime:
                          type: string
                          format: date-time
        '400':
          description: Invalid parameters
          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 `areas:read` scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformError'
        '404':
          description: Area 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:
    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_...)

````