> ## 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 calendar event participants for group workout start

> Returns active event bookings and any existing group-workout run participants for the event, including terminal participants such as cancelled members, so member counts match the workout run state.

Requires the workout_groups:read scope. This operation maps to /app/v1/coach/workout/group/events/:eventId/context and retains its Workout V2 permission, feature-flag, and resource-scope checks.

The clientId path parameter is resolved inside the company bound to the Public API token when present.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/workout/groups/events/{eventId}/context
openapi: 3.1.0
info:
  title: FITsociety Public API v1
  version: 1.0.0
  description: >-
    Developer Public API endpoints under `/public/v1`. This reference is
    filtered to OAuth/Bearer Public API resources and excludes provider callback
    receivers, storefront routes, public widgets, wishlist routes, and
    access-device validation endpoints.
  contact:
    name: FITsociety Engineering
servers:
  - url: https://api.fitsociety.io
    description: Production
security: []
tags:
  - name: Workout
    description: >-
      Workout V2 libraries, programmes, client plans, calendars, sessions,
      groups, settings and progress. AI operations are excluded.
  - name: OAuth
    description: Public API OAuth endpoints for server-to-server client credentials.
  - name: Health
    description: Public API token health checks.
  - name: Platform
    description: >-
      Inspect Public API client context, capabilities, scopes, and redacted
      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 with
      guarded finance writes.
  - name: Credits
    description: >-
      Read company-wide and client-scoped credit allocations, mutations, and
      guarded credit adjustments.
  - 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.
paths:
  /public/v1/workout/groups/events/{eventId}/context:
    get:
      tags:
        - Workout
      summary: Get calendar event participants for group workout start
      description: >-
        Returns active event bookings and any existing group-workout run
        participants for the event, including terminal participants such as
        cancelled members, so member counts match the workout run state.


        Requires the workout_groups:read scope. This operation maps to
        /app/v1/coach/workout/group/events/:eventId/context and retains its
        Workout V2 permission, feature-flag, and resource-scope checks.


        The clientId path parameter is resolved inside the company bound to the
        Public API token when present.
      operationId: publicWorkoutgetPublicV1WorkoutGroupsEventsEventIdContext
      parameters:
        - in: path
          name: eventId
          required: true
          description: Calendar event id.
          schema:
            type: string
            example: 67f1234567890abcdef1234
        - in: query
          name: instanceStart
          schema:
            type: string
            format: date-time
            example: '2026-04-12T10:00:00.000Z'
          description: >-
            Optional occurrence start date for recurring calendar events. When
            provided, participants and existing runs are scoped to that single
            occurrence.
      responses:
        '200':
          description: Group workout context.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        $ref: >-
                          #/components/schemas/PublicWorkoutSourceGETAppV1CoachWorkoutGroupEventsEventIdContextResponse200
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      event:
                        eventId: 67f1234567890abcdef1234
                        startDate: null
                        endDate: null
                        lessonName: Small Group Training
                        lessonType: group
                      session:
                        runId: null
                        status: paused
                        runStatus: active
                        source: calendar_event
                        calendarOccurrenceStartDate: null
                        startedAt: null
                        endedAt: null
                        timerStartedAt: null
                        timerPausedAt: null
                        timerElapsedMs: 120000
                        participantStatusCounts:
                          total: 4
                          active: 3
                          pending: 0
                          in_progress: 2
                          paused: 1
                          completed: 1
                          stopped: 0
                          cancelled: 0
                          error: 0
                      members:
                        - clientId: 67f1234567890abcdef1234
                          firstName: Joseph
                          lastName: Quin
                          fullName: Joseph Quin
                          email: joseph@example.com
                          image: https://cdn.example.com/avatar.jpg
                          isActive: true
                          tags:
                            - _id: 67f1234567890abcdef1234
                              id: 67f1234567890abcdef1234
                              name: VIP
                              label: VIP
                              color: '#105DFB'
                          memberships:
                            - _id: 67f1234567890abcdef1234
                              id: 67f1234567890abcdef1234
                              membershipId: null
                              storeModuleMembershipId: null
                              productName: Premium Monthly
                              name: Premium Monthly
                              status: Active
                              startDate: null
                              endDate: null
                              expiresAt: null
                              nextBillingDate: null
                              autoRenewCheck: false
                          activeMembership:
                            _id: 67f1234567890abcdef1234
                            id: 67f1234567890abcdef1234
                            membershipId: null
                            storeModuleMembershipId: null
                            productName: Premium Monthly
                            name: Premium Monthly
                            status: Active
                            startDate: null
                            endDate: null
                            expiresAt: null
                            nextBillingDate: null
                            autoRenewCheck: false
                          membershipExpiresAt: null
                          remainingCredits: 23
                          creditBalance: 23
                          nextTrainingAt: null
                          nextTrainingBookingId: null
                          groupWorkoutSession:
                            sessionId: null
                            sessionStatus: paused
                            workoutSource: auto_assigned_plan
                            sourceLabel: Assigned plan
                            startedAt: null
                            endedAt: null
                      counts:
                        members: 4
                        sessionStatuses:
                          total: 4
                          active: 3
                          pending: 0
                          in_progress: 2
                          paused: 1
                          completed: 1
                          stopped: 0
                          cancelled: 0
                          error: 0
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          $ref: '#/components/schemas/ErrorResponse'
          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':
          description: Coach is not assigned to the event.
          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:
                          - required:scope
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: Calendar event not found.
          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/groups/events/{eventId}/context"
            \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicWorkoutSourceGETAppV1CoachWorkoutGroupEventsEventIdContextResponse200:
      type: object
      properties:
        event:
          type: object
          properties:
            eventId:
              type: string
              example: 67f1234567890abcdef1234
            startDate:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            endDate:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            lessonName:
              type: string
              example: Small Group Training
            lessonType:
              type: string
              example: group
        session:
          type: object
          properties:
            runId:
              type:
                - string
                - 'null'
              example: null
            status:
              type: string
              enum:
                - not_started
                - in_progress
                - paused
                - completed
                - cancelled
                - active
              example: paused
            runStatus:
              type:
                - string
                - 'null'
              enum:
                - active
                - completed
                - cancelled
                - null
              example: active
            source:
              type: string
              example: calendar_event
            calendarOccurrenceStartDate:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            startedAt:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            endedAt:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            timerStartedAt:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            timerPausedAt:
              type:
                - string
                - 'null'
              format: date-time
              example: null
            timerElapsedMs:
              type: number
              example: 120000
            participantStatusCounts:
              type: object
              properties:
                total:
                  type: number
                  example: 4
                active:
                  type: number
                  example: 3
                pending:
                  type: number
                  example: 0
                in_progress:
                  type: number
                  example: 2
                paused:
                  type: number
                  example: 1
                completed:
                  type: number
                  example: 1
                stopped:
                  type: number
                  example: 0
                cancelled:
                  type: number
                  example: 0
                error:
                  type: number
                  example: 0
        members:
          type: array
          items:
            type: object
            properties:
              clientId:
                type: string
                example: 67f1234567890abcdef1234
              firstName:
                type: string
                example: Joseph
              lastName:
                type: string
                example: Quin
              fullName:
                type: string
                example: Joseph Quin
              email:
                type: string
                example: joseph@example.com
              image:
                type: string
                example: https://cdn.example.com/avatar.jpg
              isActive:
                type: boolean
                example: true
              tags:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                      example: 67f1234567890abcdef1234
                    id:
                      type: string
                      example: 67f1234567890abcdef1234
                    name:
                      type: string
                      example: VIP
                    label:
                      type: string
                      example: VIP
                    color:
                      type: string
                      example: '#105DFB'
              memberships:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                      example: 67f1234567890abcdef1234
                    id:
                      type: string
                      example: 67f1234567890abcdef1234
                    membershipId:
                      type:
                        - string
                        - 'null'
                      example: null
                    storeModuleMembershipId:
                      type:
                        - string
                        - 'null'
                      example: null
                    productName:
                      type: string
                      example: Premium Monthly
                    name:
                      type: string
                      example: Premium Monthly
                    status:
                      type: string
                      example: Active
                    startDate:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      example: null
                    endDate:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      example: null
                    expiresAt:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      example: null
                    nextBillingDate:
                      type:
                        - string
                        - 'null'
                      format: date-time
                      example: null
                    autoRenewCheck:
                      type: boolean
                      example: false
              activeMembership:
                oneOf:
                  - type: object
                    properties:
                      _id:
                        type: string
                        example: 67f1234567890abcdef1234
                      id:
                        type: string
                        example: 67f1234567890abcdef1234
                      membershipId:
                        type:
                          - string
                          - 'null'
                        example: null
                      storeModuleMembershipId:
                        type:
                          - string
                          - 'null'
                        example: null
                      productName:
                        type: string
                        example: Premium Monthly
                      name:
                        type: string
                        example: Premium Monthly
                      status:
                        type: string
                        example: Active
                      startDate:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: null
                      endDate:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: null
                      expiresAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: null
                      nextBillingDate:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: null
                      autoRenewCheck:
                        type: boolean
                        example: false
                  - type: 'null'
              membershipExpiresAt:
                type:
                  - string
                  - 'null'
                format: date-time
                example: null
              remainingCredits:
                type: number
                example: 23
              creditBalance:
                type: number
                example: 23
              nextTrainingAt:
                type:
                  - string
                  - 'null'
                format: date-time
                example: null
              nextTrainingBookingId:
                type:
                  - string
                  - 'null'
                example: null
              groupWorkoutSession:
                oneOf:
                  - type: object
                    properties:
                      sessionId:
                        type:
                          - string
                          - 'null'
                        example: null
                      sessionStatus:
                        type: string
                        enum:
                          - pending
                          - in_progress
                          - paused
                          - completed
                          - stopped
                          - cancelled
                          - error
                        example: paused
                      workoutSource:
                        type: string
                        example: auto_assigned_plan
                      sourceLabel:
                        type: string
                        example: Assigned plan
                      startedAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: null
                      endedAt:
                        type:
                          - string
                          - 'null'
                        format: date-time
                        example: null
                  - type: 'null'
        counts:
          type: object
          properties:
            members:
              type: number
              example: 4
            sessionStatuses:
              type: object
              properties:
                total:
                  type: number
                  example: 4
                active:
                  type: number
                  example: 3
                pending:
                  type: number
                  example: 0
                in_progress:
                  type: number
                  example: 2
                paused:
                  type: number
                  example: 1
                completed:
                  type: number
                  example: 1
                stopped:
                  type: number
                  example: 0
                cancelled:
                  type: number
                  example: 0
                error:
                  type: number
                  example: 0
    ErrorResponse:
      allOf:
        - $ref: '#/components/schemas/StandardResponse'
        - example:
            status: 401
            error: true
            message: MISSING_AUTH
    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'
    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.