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

# List area blocks

> Returns the blocks overlapping a window - the time-ranged unavailability of a court, the counterpart of instructor time off. A block with `areaId: null` is club-wide and closes every area in `clubId`; expand it against the club's areas the same way availability does. Filtering by `areaId` includes the club-wide blocks covering that area, so the result is everything that closes it.




## OpenAPI

````yaml /openapi-platform.json get /v1/platform/area-blocks
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.


    ## 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 |
  contact:
    name: 1club API Support
    email: support@1club.ai
servers:
  - url: https://api.1club.ai
    description: Production API
security:
  - customerApiAuth: []
tags: []
paths:
  /v1/platform/area-blocks:
    get:
      tags:
        - Area Blocks
      summary: List area blocks
      description: >
        Returns the blocks overlapping a window - the time-ranged unavailability
        of a court, the counterpart of instructor time off. A block with
        `areaId: null` is club-wide and closes every area in `clubId`; expand it
        against the club's areas the same way availability does. Filtering by
        `areaId` includes the club-wide blocks covering that area, so the result
        is everything that closes it.
      parameters:
        - 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`.
        - in: query
          name: clubId
          schema:
            type: integer
          description: Only return blocks for this club
        - in: query
          name: areaId
          schema:
            type: integer
          description: Only return blocks affecting this area (club-wide ones included)
      responses:
        '200':
          description: List of area blocks
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  properties:
                    id:
                      type: integer
                    clubId:
                      type: integer
                    areaId:
                      type: integer
                      nullable: true
                      description: Null means every area in the club
                    areaName:
                      type: string
                      nullable: true
                    startTime:
                      type: string
                      format: date-time
                    endTime:
                      type: string
                      format: date-time
                    note:
                      type: string
                      nullable: true
                    createdAt:
                      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'
        '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: >-
        Organization-scoped bearer credential: a customer API key
        (1club_sk_live_...) or an MCP OAuth access token.

````