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

# List export requests

> Requires `exports:read`. Lists only export requests created by the authenticated Public API client.



## OpenAPI

````yaml /openapi/public-v1.json get /public/v1/exports/requests
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: 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/exports/requests:
    get:
      tags:
        - Exports
      summary: List export requests
      description: >-
        Requires `exports:read`. Lists only export requests created by the
        authenticated Public API client.
      operationId: getPublicV1ExportsRequests
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            minimum: 1
            maximum: 100
            example: 25
        - name: cursor
          in: query
          schema:
            type: string
            format: date-time
            example: '2026-07-14T10:00:00.000Z'
          description: Use the previous response `nextCursor` value to fetch the next page.
        - name: status
          in: query
          schema:
            type: string
            example: completed,failed
          description: Comma-separated export statuses, or `in(completed,failed)`.
        - name: typeId
          in: query
          schema:
            type: string
            example: company-clients-xlsx
        - name: language
          in: query
          schema:
            type: string
            example: en
          description: >-
            Optional label language. When omitted, the `Accept-Language` header
            is used.
      responses:
        '200':
          description: Export requests fetched
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/PublicApiSuccessResponse'
                  - type: object
                    properties:
                      data:
                        type: object
                        additionalProperties: false
                        required:
                          - exportRequests
                          - nextCursor
                        properties:
                          exportRequests:
                            type: array
                            items:
                              $ref: '#/components/schemas/PublicExportRequest'
                          nextCursor:
                            type:
                              - string
                              - 'null'
                            format: date-time
                            example: null
              examples:
                success:
                  summary: Successful response
                  value:
                    data:
                      exportRequests:
                        - exportRequestId: 66f7b8b1e13c8d25f4d3d90a
                          typeId: company-clients-xlsx
                          typeLabel: Client List (XLSX)
                          status: completed
                          progress: 100
                          rowCount: 128
                          format: xlsx
                          paramsSummary: 'Fields: 12 selected'
                          file:
                            downloadUrl: https://exports.example.com/company-clients.xlsx
                            format: xlsx
                            sizeBytes: 24576
                            expiresAt: '2026-07-21T10:00:00.000Z'
                          error:
                            code: EXPORT_FAILED
                            message: The export could not be completed.
                          createdAt: '2026-07-14T10:00:00.000Z'
                          startedAt: '2026-07-14T10:00:00.000Z'
                          completedAt: '2026-07-14T10:00:00.000Z'
                          updatedAt: '2026-07-14T10:00:00.000Z'
                          previousExportRequestId: null
                      nextCursor: null
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '400':
          description: >-
            Bad request. The request shape, query, path parameter, or
            idempotency header is invalid.
          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':
          description: >-
            Unauthorized. The Bearer token is missing, invalid, expired, or
            belongs to an inactive Public API client.
          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: >-
            Forbidden. The token is valid but does not include the required
            scope.
          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:
                          - exports:read
                    meta:
                      requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83
                      rateLimit:
                        limit: 10
                        remaining: 9
                        resetSeconds: 1
        '404':
          description: >-
            Not found. The requested company-scoped resource does not exist or
            is not accessible to this token.
          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
        '429':
          description: >-
            Too many requests. The Public API client or caller IP exceeded the
            rate limit.
          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: >-
            Server error. The request could not be completed because of an
            unexpected Public API server failure.
          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/exports/requests" \
              -H "Authorization: Bearer <access_token>"
components:
  schemas:
    PublicApiSuccessResponse:
      type: object
      additionalProperties: false
      required:
        - data
        - meta
      properties:
        data:
          type: object
        meta:
          $ref: '#/components/schemas/PublicApiMeta'
    PublicExportRequest:
      type: object
      additionalProperties: false
      required:
        - exportRequestId
        - typeId
        - typeLabel
        - status
        - progress
        - rowCount
        - format
        - paramsSummary
        - file
        - error
        - createdAt
        - startedAt
        - completedAt
        - updatedAt
        - previousExportRequestId
      properties:
        exportRequestId:
          type: string
          example: 66f7b8b1e13c8d25f4d3d90a
        typeId:
          type: string
          example: company-clients-xlsx
        typeLabel:
          type: string
          example: Client List (XLSX)
        status:
          type: string
          enum:
            - queued
            - running
            - completed
            - failed
            - canceled
            - expired
            - deleted
          example: completed
        progress:
          type:
            - number
            - 'null'
          example: 100
        rowCount:
          type:
            - integer
            - 'null'
          example: 128
        format:
          type: string
          enum:
            - xlsx
            - csv
            - zip
            - ''
          example: xlsx
        paramsSummary:
          type: string
          example: 'Fields: 12 selected'
        file:
          $ref: '#/components/schemas/PublicExportFile'
        error:
          $ref: '#/components/schemas/PublicExportErrorInfo'
        createdAt:
          type:
            - string
            - 'null'
          format: date-time
        startedAt:
          type:
            - string
            - 'null'
          format: date-time
        completedAt:
          type:
            - string
            - 'null'
          format: date-time
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
        previousExportRequestId:
          type:
            - string
            - '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'
    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'
    PublicExportFile:
      type:
        - object
        - 'null'
      additionalProperties: false
      properties:
        downloadUrl:
          type: string
          format: uri
          description: >-
            Signed temporary download URL for the exported file. Fetch the
            request again to receive a fresh URL while the export file has not
            expired.
          example: https://exports.example.com/company-clients.xlsx
        format:
          type: string
          enum:
            - xlsx
            - csv
            - zip
          example: xlsx
        sizeBytes:
          type:
            - integer
            - 'null'
          example: 24576
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Expiry timestamp for the exported file and returned download URL.
          example: '2026-07-21T10:00:00.000Z'
    PublicExportErrorInfo:
      type:
        - object
        - 'null'
      additionalProperties: false
      properties:
        code:
          type: string
          example: EXPORT_FAILED
        message:
          type: string
          example: The export could not be completed.
    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`.

````