> ## 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 club-wide availability grid > Returns computed open slots for every bookable area in one call, so you can render a whole calendar without a request per court. Filter by `clubId` and/or `sport`. Each area carries its own `version`; the top-level `cursor` is the reconciliation cursor to pass to `/availability/changes` next. ## OpenAPI ````yaml /openapi-platform.json get /v1/platform/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. ## 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/availability: get: tags: - Areas summary: Get club-wide availability grid description: > Returns computed open slots for every bookable area in one call, so you can render a whole calendar without a request per court. Filter by `clubId` and/or `sport`. Each area carries its own `version`; the top-level `cursor` is the reconciliation cursor to pass to `/availability/changes` next. parameters: - in: query name: clubId schema: type: integer description: Only include areas belonging to this club - in: query name: sport schema: type: string description: Only include areas whose type lists this sport (e.g. "padel") - 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: slotMinutes schema: type: integer enum: - 15 - 30 - 60 - 90 - 120 default: 60 description: Granularity of computed slots in minutes. responses: '200': description: Club availability grid content: application/json: schema: type: object properties: clubId: type: integer nullable: true timezone: type: string from: type: string format: date-time to: type: string format: date-time cursor: type: string description: Reconciliation cursor at read time areas: type: array items: type: object properties: areaId: type: integer name: type: string sports: type: array items: type: string pricePerHour: type: number nullable: true maxConcurrentBookings: type: integer version: type: string operatingHours: type: object busy: type: array items: type: object properties: startTime: type: string format: date-time endTime: type: string format: date-time subject: type: string enum: - member_booking - class - event - area_block description: > What holds the court for this interval, in the same vocabulary as `details.conflicts[].subject` on a refused create. `class` is a scheduled class holding its court - which is a booking row underneath, so it is not distinguishable by shape - and `area_block` is the club closing the court (maintenance, a private hire) rather than a sale. No id or name is attached - an availability read is not a read of who booked; use GET /v1/platform/bookings for the rows you may see. slots: type: array items: type: object properties: start: type: string format: date-time end: type: string format: date-time capacity: type: integer remaining: type: integer bookable: type: boolean '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. ````