> ## 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 check-in



## OpenAPI

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


    ## 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/checkins/{id}:
    get:
      tags:
        - Check-ins
      summary: Get a check-in
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Check-in details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformCheckin'
        '403':
          description: Missing `checkins:read` scope
        '404':
          $ref: '#/components/responses/PlatformNotFound'
      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
  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.

````