> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fitsociety.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the full paginated weekly ranking (leaderboard)

> The full paginated 'Your ranking this week' list (the 'See all' screen behind the compact `weeklyRanking` card on the client Training page). Response shape mirrors the WOD leaderboard: `podium[]` (full top-3 rows), `data[]` (paginated slice starting at rank 4 — the podium is excluded and never repeated), `currentUser` (the client's own row, ALWAYS returned and pinned statically — e.g. rank 200 stays fixed while `data` scrolls; carries the 'XP to next rank' progress), `avatars` (compact top-3 strip), `totalCount`, `othersCount`, `pagination` (counts participants excluding the podium). Page size defaults to 10. Self-gated by the leaderboard config (`enabled` + `weeklyLeaderboardEnabled`) and the client's visibility. Pass `weekStart=YYYY-MM-DD` to view a closed past week (e.g. from the weekly `leaderboard_position` notification); without it the current week is returned as before. Past weeks return `isCurrentWeek: false` and `resetLabel: null`. Anonymity (applied to `data`, `avatars`, and `currentUser`): company `anonymousMode: 'names'` masks other members' names to 'Member #rank' (image kept); `'names_and_profiles'` also drops the image (`anonymousAvatar: true`); a personally-anonymous member becomes 'Anonymous' with no image. Company modes never mask the current user, but their own personal anonymity does ('Anonymous (You)').

Requires the `workout_progress:read` scope and the corresponding Workout features and permissions.

The clientId path parameter identifies a client in the company bound to the Public API token.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/clients/{clientId}/weekly-ranking
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Integrate with FITsociety through `/public/v1`. Use OAuth client credentials
    to obtain a Bearer access token, then call the endpoints available to the
    authenticated company and granted scopes.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Health
    description: Public API token health checks.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Platform
    description: Inspect Public API client context, capabilities, scopes, and audit logs.
  - name: Company Catalog
    description: Read and manage company profile metadata and locations.
  - name: Clients
    description: >-
      Create and manage clients through the Public API using Bearer access
      tokens.
  - name: Coaches
    description: Retrieve coaches for the authenticated company via integrations.
  - name: Calendar Events
    description: Read Public API calendar events.
  - name: Calendar Templates
    description: >-
      Read and manage event types and event templates used by calendar
      availability and bookings.
  - name: Calendar Extensions
    description: >-
      Read recurring bookings, booking requests, calendar tasks, and
      availability closure metadata.
  - name: Availability
    description: Read bookable availability slots and signed availability tokens.
  - name: Availability Management
    description: >-
      Manage coach and location availability templates used to derive bookable
      slots.
  - name: Bookings
    description: Read and manage Public API bookings.
  - name: Finance
    description: >-
      Read invoices, transactions, products, subscriptions, and memberships, and
      manage finance actions.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations and mutations, and
      adjust credits.
  - name: Exports
    description: >-
      Create and monitor asynchronous company exports through Public API Bearer
      endpoints.
  - name: Webhooks
    description: >-
      Manage outbound webhook subscriptions and inspect delivery attempts
      through Public API Bearer endpoints.
  - name: Measurements
    description: Read and write client measurement entries.
  - name: Progress Photos
    description: Read client progress photo metadata and short-lived signed media URLs.
  - name: Forms
    description: Read, create, update, and archive company form templates.
  - name: Intakes
    description: Assign intake forms and read client intake assignments and submissions.
  - name: Check-ups
    description: >-
      Schedule and cancel client check-ups and read their status and
      submissions.
  - name: Documents
    description: >-
      Read client document and folder metadata, register external document
      links, update metadata, and archive documents from Public API listings.
      Binary upload, permanent deletion, and company-wide document management
      are not exposed.
  - name: Habits
    description: Read habits and habit entries.
  - name: Goals
    description: Read client goal summaries.
  - name: Conversations
    description: >-
      Read and manage direct and group chat conversations through the Public
      API.
  - name: Reports
    description: Read aggregate attendance, revenue, and retention summaries.
  - name: Workout
    description: >-
      Workout libraries, programmes, client plans, calendars, sessions, groups,
      settings and progress. AI operations are excluded.
paths:
  /public/v1/workout/clients/{clientId}/weekly-ranking:
    get:
      tags:
        - Workout
      summary: Get the full paginated weekly ranking (leaderboard)
      description: >-
        The full paginated 'Your ranking this week' list (the 'See all' screen
        behind the compact `weeklyRanking` card on the client Training page).
        Response shape mirrors the WOD leaderboard: `podium[]` (full top-3
        rows), `data[]` (paginated slice starting at rank 4 — the podium is
        excluded and never repeated), `currentUser` (the client's own row,
        ALWAYS returned and pinned statically — e.g. rank 200 stays fixed while
        `data` scrolls; carries the 'XP to next rank' progress), `avatars`
        (compact top-3 strip), `totalCount`, `othersCount`, `pagination` (counts
        participants excluding the podium). Page size defaults to 10. Self-gated
        by the leaderboard config (`enabled` + `weeklyLeaderboardEnabled`) and
        the client's visibility. Pass `weekStart=YYYY-MM-DD` to view a closed
        past week (e.g. from the weekly `leaderboard_position` notification);
        without it the current week is returned as before. Past weeks return
        `isCurrentWeek: false` and `resetLabel: null`. Anonymity (applied to
        `data`, `avatars`, and `currentUser`): company `anonymousMode: 'names'`
        masks other members' names to 'Member #rank' (image kept);
        `'names_and_profiles'` also drops the image (`anonymousAvatar: true`); a
        personally-anonymous member becomes 'Anonymous' with no image. Company
        modes never mask the current user, but their own personal anonymity does
        ('Anonymous (You)').


        Requires the `workout_progress:read` scope and the corresponding Workout
        features and permissions.


        The clientId path parameter identifies a client in the company bound to
        the Public API token.
      operationId: publicWorkoutgetPublicV1WorkoutClientsClientIdWeeklyRanking
      parameters:
        - in: query
          name: clientId
          required: false
          schema:
            type: string
            example: 67f1234567890abcdef1234
          description: Identifies a client in the company bound to the Public API token.
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            example: 1
            default: 1
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 10
            maximum: 100
            example: 10
            default: 10
          description: Page size. Defaults to 10.
        - in: query
          name: weekStart
          required: false
          schema:
            type: string
            format: date
            example: '2026-10-04'
          description: >-
            Show a past week instead of the current one: any date inside that
            week (YYYY-MM-DD), normalised to its Sunday 00:00 UTC start. Omit
            for the current week (unchanged behaviour). The
            `leaderboard_position` notification's `action.data.weekStart` can be
            passed as-is. A date in a future week returns 400
            `LEADERBOARD_WEEK_START_INVALID`.
        - in: query
          name: gender
          required: false
          schema:
            type: string
            enum:
              - male
              - female
              - prefer_not_to_say
              - all
            example: female
          description: >-
            Show only members of this gender. `prefer_not_to_say` includes
            members without a stated gender and members who chose 'Other'. Omit,
            leave empty or pass `all` for everyone. The response shape is
            unchanged: ranks, `podium`, `data`, `currentUser`, `totalCount` and
            `pagination` are all computed within the filtered board, and
            `currentUser` is empty when the client is outside the filter. Any
            other value returns 400 `LEADERBOARD_FILTER_INVALID`.
        - in: query
          name: scoringType
          required: false
          schema:
            type: string
            enum:
              - standard
              - forTime
              - amrap
              - emom
              - tabata
              - maxLoad
              - all
            example: maxLoad
          description: >-
            Rank by the XP earned only from WODs with this scoring type in the
            week, so `xp`, ranks and the podium reflect those WODs alone. A WOD
            set to `standard` uses the scoring type of its planned workout.
            Members without XP from matching WODs are not listed. Omit or pass
            `all` for total weekly XP. Combines with `gender` and
            `allowedDivisions`. Any other value returns 400
            `LEADERBOARD_FILTER_INVALID`.
        - in: query
          name: allowedDivisions
          required: false
          schema:
            type: string
            enum:
              - rx
              - scaled
              - rx_scaled
              - all
            example: rx_scaled
          description: >-
            Rank by the XP earned only from WODs whose allowed divisions are
            exactly this set: `rx` (RX only), `scaled` (Scaled only) or
            `rx_scaled` (both). It filters on the WOD setting, not on the
            division a member chose. Omit or pass `all` for total weekly XP.
            Combines with `gender` and `scoringType`. Any other value returns
            400 `LEADERBOARD_FILTER_INVALID`.
        - name: clientId
          in: path
          required: true
          schema:
            type: string
            pattern: ^[a-fA-F0-9]{24}$
          description: Client in the company bound to the Public API token.
      responses:
        '200':
          description: Paginated weekly ranking with static current-user row.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1WorkoutClientWeeklyRankingResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      enabled: true
                      hidden: false
                      isCurrentWeek: true
                      resetLabel: Reset in 4 days - Sunday Midnight
                      weekStart: '2026-07-12T00:00:00.000Z'
                      weekEnd: '2026-07-19T00:00:00.000Z'
                      podium:
                        - rank: 4
                          clientId: 67f1234567890abcdef1234
                          firstName: Kaylynn
                          lastName: Lubin
                          name: Kaylynn Lubin
                          image: https://cdn.example.com/4.jpg
                          xp: 3895
                          trend: up
                          anonymousAvatar: false
                          isCurrentUser: false
                      data:
                        - rank: 4
                          clientId: 67f1234567890abcdef1234
                          firstName: Kaylynn
                          lastName: Lubin
                          name: Kaylynn Lubin
                          image: https://cdn.example.com/4.jpg
                          xp: 3895
                          trend: up
                          anonymousAvatar: false
                          isCurrentUser: false
                      currentUser:
                        rank: 200
                        clientId: 67f1234567890abcdef1234
                        firstName: Wilson
                        lastName: Calzoni
                        name: Wilson Calzoni
                        image: https://cdn.example.com/you.jpg
                        anonymousAvatar: false
                        xp: 320
                        trend: down
                        nextRank: 199
                        nextRankValue: 340
                        xpToNextRank: 20
                        progressToNextRank: 0.94
                        participating: true
                        inCurrentPage: false
                        isCurrentUser: true
                      avatars:
                        - clientId: 67f1234567890abcdef1234
                          image: https://cdn.example.com/clients/a1.jpg
                          name: Bryan Wolf
                      totalCount: 213
                      othersCount: 210
                      pagination:
                        page: 1
                        limit: 10
                        totalPages: 16
                        totalItems: 153
                        hasNextPage: true
                        hasPreviousPage: false
                        nextPage: 2
                        previousPage: false
                        totalAvailableItems: 1
                      availableFilters:
                        gender:
                          - key: male
                            label: Male
                          - key: female
                            label: Female
                          - key: prefer_not_to_say
                            label: Prefer not to say
                        scoringType:
                          - key: standard
                            label: Standard
                          - key: forTime
                            label: For Time
                          - key: amrap
                            label: AMRAP
                          - key: emom
                            label: EMOM
                          - key: tabata
                            label: Tabata
                          - key: maxLoad
                            label: Max Load
                        allowedDivisions:
                          - key: rx
                            label: RX
                          - key: scaled
                            label: Scaled
                          - key: rx_scaled
                            label: RX & Scaled
                      selectedFilters:
                        gender: female
                        scoringType: maxLoad
                        allowedDivisions: null
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: >-
            Company context is missing (`COMPANY_ID_REQUIRED`), client id is
            absent/malformed (`INVALID_CLIENT_ID`), pagination is invalid
            (`MAX_PAGE_LIMIT_EXCEEDED` / `MAX_ENTRIES_LIMIT_EXCEEDED`),
            `weekStart` is not a YYYY-MM-DD date outside future weeks
            (`LEADERBOARD_WEEK_START_INVALID`), or `gender`, `scoringType` or
            `allowedDivisions` has an unsupported value
            (`LEADERBOARD_FILTER_INVALID`, message names the filter and its
            allowed values).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                invalidRequest:
                  summary: Invalid request
                  value:
                    error:
                      code: 400
                      key: request.invalid
                      message: The request is invalid.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '401':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                missingBearer:
                  summary: Missing Bearer token
                  value:
                    error:
                      code: 401
                      key: auth.missing_bearer
                      message: Authorization Bearer token is required.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidToken:
                  summary: Invalid or expired token
                  value:
                    error:
                      code: 401
                      key: auth.invalid_token
                      message: The access token is invalid or expired.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
                invalidClient:
                  summary: Inactive or revoked client
                  value:
                    error:
                      code: 401
                      key: auth.invalid_client
                      message: The Public API client is inactive or revoked.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '403':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                insufficientScopes:
                  summary: Missing required scope
                  value:
                    error:
                      code: 403
                      key: scopes.insufficient
                      message: The access token does not include the required scope.
                      details:
                        requiredScopes:
                          - workout_progress:read
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                notFound:
                  summary: Resource not found
                  value:
                    error:
                      code: 404
                      key: resource.not_found
                      message: The requested Public API resource was not found.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '409':
          $ref: '#/components/schemas/ErrorResponse'
        '422':
          $ref: '#/components/schemas/ErrorResponse'
        '429':
          $ref: '#/components/schemas/ErrorResponse'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                rateLimitExceeded:
                  summary: Rate limit exceeded
                  value:
                    error:
                      code: 429
                      key: rate_limit.exceeded
                      message: Too many Public API requests. Retry later.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 0
                        resetSeconds: 1
                        retryAfterSeconds: 1
        '500':
          description: Unexpected server error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicApiError'
              examples:
                serverInternalError:
                  summary: Unexpected server error
                  value:
                    error:
                      code: 500
                      key: server.internal_error
                      message: An unexpected Public API server error occurred.
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
      security:
        - PublicBearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: >-
            curl -X GET
            "https://api.fitsociety.io/public/v1/workout/clients/{clientId}/weekly-ranking"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1WorkoutClientWeeklyRankingResponse200:
      type: object
      properties:
        enabled:
          type: boolean
          example: true
          description: '`false` when the leaderboard / weekly leaderboard is disabled.'
        hidden:
          type: boolean
          example: false
          description: '`true` when the client hid themselves from leaderboards.'
        isCurrentWeek:
          type: boolean
          example: true
          description: >-
            `true` for the running week (no `weekStart` query, or one inside the
            current week); `false` for a closed past week.
        resetLabel:
          type:
            - string
            - 'null'
          example: Reset in 4 days - Sunday Midnight
          description: '`null` for a closed past week.'
        weekStart:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-12T00:00:00.000Z'
          description: >-
            Sunday 00:00 UTC that starts the shown week (the requested week, or
            the current one).
        weekEnd:
          type:
            - string
            - 'null'
          format: date-time
          example: '2026-07-19T00:00:00.000Z'
        podium:
          type: array
          description: >-
            The podium — full rows for the top 3 by XP (same shape as `data`).
            Rendered separately above the list and EXCLUDED from `data`.
          items:
            type: object
            properties:
              rank:
                type: integer
                example: 4
              clientId:
                type: string
                example: 67f1234567890abcdef1234
              firstName:
                type: string
                example: Kaylynn
              lastName:
                type: string
                example: Lubin
              name:
                type: string
                example: Kaylynn Lubin
              image:
                type: string
                example: https://cdn.example.com/4.jpg
              xp:
                type: integer
                example: 3895
              trend:
                type: string
                enum:
                  - up
                  - down
                  - flat
                example: up
              anonymousAvatar:
                type: boolean
                example: false
                description: >-
                  `true` when this row's image is hidden and a placeholder
                  avatar should be shown — under company `anonymousMode:
                  'names_and_profiles'` (name → 'Member #rank') or when the
                  member is personally anonymous (name → 'Anonymous'). Under
                  `anonymousMode: 'names'` the name is masked but the image is
                  kept, so this stays `false`.
              isCurrentUser:
                type: boolean
                example: false
        data:
          type: array
          description: >-
            Paginated leaderboard slice BELOW the podium — starts at rank 4 on
            page 1 (the top 3 live in `podium`/`avatars` and are never repeated
            here).
          items:
            type: object
            properties:
              rank:
                type: integer
                example: 4
              clientId:
                type: string
                example: 67f1234567890abcdef1234
              firstName:
                type: string
                example: Kaylynn
              lastName:
                type: string
                example: Lubin
              name:
                type: string
                example: Kaylynn Lubin
              image:
                type: string
                example: https://cdn.example.com/4.jpg
              xp:
                type: integer
                example: 3895
              trend:
                type: string
                enum:
                  - up
                  - down
                  - flat
                example: up
              anonymousAvatar:
                type: boolean
                example: false
                description: >-
                  `true` when this row's image is hidden and a placeholder
                  avatar should be shown — under company `anonymousMode:
                  'names_and_profiles'` (name → 'Member #rank') or when the
                  member is personally anonymous (name → 'Anonymous'). Under
                  `anonymousMode: 'names'` the name is masked but the image is
                  kept, so this stays `false`.
              isCurrentUser:
                type: boolean
                example: false
        currentUser:
          type: object
          nullable: true
          description: >-
            The current client's own row + 'XP to next rank' progress, ALWAYS
            returned in full and pinned statically (even at rank 200). `null`
            when not participating. `inCurrentPage` = whether it also appears in
            `data` (false when the client is in the podium).
          properties:
            rank:
              type: integer
              example: 200
            clientId:
              type: string
              example: 67f1234567890abcdef1234
            firstName:
              type: string
              example: Wilson
            lastName:
              type: string
              example: Calzoni
            name:
              type: string
              example: Wilson Calzoni
            image:
              type: string
              example: https://cdn.example.com/you.jpg
            anonymousAvatar:
              type: boolean
              example: false
              description: >-
                `true` when the client set themselves personally anonymous —
                `name` becomes 'Anonymous' and `image` is empty on their own
                pinned row ('Anonymous (You)'). Company anonymousMode never
                masks the current user.
            xp:
              type: integer
              example: 320
            trend:
              type: string
              enum:
                - up
                - down
                - flat
              example: down
            nextRank:
              type:
                - integer
                - 'null'
              example: 199
            nextRankValue:
              type:
                - number
                - 'null'
              example: 340
            xpToNextRank:
              type:
                - number
                - 'null'
              example: 20
            progressToNextRank:
              type:
                - number
                - 'null'
              example: 0.94
            participating:
              type: boolean
              example: true
            inCurrentPage:
              type: boolean
              example: false
            isCurrentUser:
              type: boolean
              example: true
        avatars:
          type: array
          description: >-
            Compact { clientId, image, name } strip for the same top 3 as
            `podium`.
          items:
            type: object
            properties:
              clientId:
                type: string
                example: 67f1234567890abcdef1234
              image:
                type: string
                example: https://cdn.example.com/clients/a1.jpg
              name:
                type: string
                example: Bryan Wolf
        totalCount:
          type: integer
          example: 213
          description: Total distinct weekly participants.
        othersCount:
          type: integer
          example: 210
          description: '`totalCount − avatars.length`.'
        pagination:
          type: object
          properties:
            page:
              type: integer
              example: 1
            limit:
              type: integer
              example: 10
            totalPages:
              type: integer
              example: 16
            totalItems:
              type: integer
              example: 153
              description: >-
                Size of the `data` list universe. For the leaderboards this
                EXCLUDES the podium top 3 (= totalCount − 3), so totalPages
                counts only the scrolling list below the podium.
            hasNextPage:
              type: boolean
              example: true
            hasPreviousPage:
              type: boolean
              example: false
            nextPage:
              oneOf:
                - type: integer
                - type: boolean
              example: 2
              description: Next page number, or `false` on the last page.
            previousPage:
              oneOf:
                - type: integer
                - type: boolean
              example: false
              description: Previous page number, or `false` on the first page.
            totalAvailableItems:
              type: integer
              minimum: 0
              description: >-
                Total matching records before the shared catalogue browse
                boundary.
        availableFilters:
          type: object
          description: >-
            Filters the client can apply. Each property is a filter (also the
            query parameter name) listing its options as `{ key, label }`, with
            labels in the client's language. Always returned, also when the
            leaderboard is disabled or hidden.
          properties:
            gender:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    enum:
                      - male
                      - female
                      - prefer_not_to_say
                    example: female
                    description: Value to send in the filter's query parameter.
                  label:
                    type: string
                    example: Female
            scoringType:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    enum:
                      - standard
                      - forTime
                      - amrap
                      - emom
                      - tabata
                      - maxLoad
                    example: maxLoad
                    description: Value to send in the filter's query parameter.
                  label:
                    type: string
                    example: Max Load
            allowedDivisions:
              type: array
              items:
                type: object
                properties:
                  key:
                    type: string
                    enum:
                      - rx
                      - scaled
                      - rx_scaled
                    example: scaled
                    description: Value to send in the filter's query parameter.
                  label:
                    type: string
                    example: Scaled
          example:
            gender:
              - key: male
                label: Male
              - key: female
                label: Female
              - key: prefer_not_to_say
                label: Prefer not to say
            scoringType:
              - key: standard
                label: Standard
              - key: forTime
                label: For Time
              - key: amrap
                label: AMRAP
              - key: emom
                label: EMOM
              - key: tabata
                label: Tabata
              - key: maxLoad
                label: Max Load
            allowedDivisions:
              - key: rx
                label: RX
              - key: scaled
                label: Scaled
              - key: rx_scaled
                label: RX & Scaled
        selectedFilters:
          type: object
          description: >-
            The filters applied to this response; `null` means the filter is
            off.
          properties:
            gender:
              type:
                - string
                - 'null'
              enum:
                - male
                - female
                - prefer_not_to_say
                - null
              example: female
            scoringType:
              type:
                - string
                - 'null'
              enum:
                - standard
                - forTime
                - amrap
                - emom
                - tabata
                - maxLoad
                - null
              example: maxLoad
            allowedDivisions:
              type:
                - string
                - 'null'
              enum:
                - rx
                - scaled
                - rx_scaled
                - null
              example: null
    PublicApiError:
      type: object
      additionalProperties: false
      required:
        - error
        - meta
      properties:
        error:
          type: object
          additionalProperties: false
          required:
            - code
            - key
            - message
          properties:
            code:
              type: integer
              example: 401
            key:
              type: string
              example: auth.invalid_token
            message:
              type: string
              example: The access token is invalid.
            details:
              type: object
              additionalProperties: true
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    PublicApiMeta:
      type: object
      additionalProperties: false
      required:
        - requestId
      properties:
        requestId:
          type: string
          description: Stable request correlation id. Mirrors `X-Request-Id` when supplied.
          example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
        rateLimit:
          $ref: '#/components/schemas/PublicApiRateLimitMeta'
    StandardResponse:
      type: object
      properties:
        status:
          type: integer
          example: 200
        error:
          type: boolean
          example: false
        message:
          type: string
          example: SUCCESS
      required:
        - status
        - error
        - message
    PublicApiRateLimitMeta:
      type: object
      additionalProperties: false
      properties:
        limit:
          type: integer
          example: 10
        remaining:
          type: integer
          example: 9
        resetSeconds:
          type: integer
          description: Seconds until the current rate limit window resets.
          example: 1
        retryAfterSeconds:
          type: integer
          description: Present when the request was rate limited.
          example: 1
  securitySchemes:
    PublicBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: Opaque
      description: >-
        Public API access token issued by `/public/v1/oauth/token`. Example:
        `Authorization: Bearer fspt_...`. Each resource request rechecks the
        token company's current provider access. Disabling access blocks
        existing tokens with `403 auth.provider_unavailable`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.