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

# Read staffing requirement evidence

> Read staffing requirement evidence for a scheduling group over the requested date range.



## OpenAPI

````yaml /api-reference/workforce/openapi.json get /api/v1/workforce/scheduling-groups/{groupId}/requirements
openapi: 3.1.0
info:
  title: Atlas workforce API
  version: 2026-10-preview
  description: >-
    Authenticated workforce staffing-to-draft operations. Released together with
    matching MCP operations. Deploy the reviewed native guard migrations before
    enabling this feature.
servers:
  - url: /
security:
  - AtlasIntegrationBearer: []
paths:
  /api/v1/workforce/scheduling-groups/{groupId}/requirements:
    get:
      summary: Read staffing requirement evidence
      description: >-
        Read staffing requirement evidence for a scheduling group over the
        requested date range.
      operationId: inspect_staffing_requirements
      parameters:
        - name: X-Workspace-Id
          in: header
          required: true
          schema:
            type: string
            format: uuid
          description: >-
            Selector within saved grants and current issuer authority; never
            grants authority.
        - name: from
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: to
          in: query
          required: true
          schema:
            type: string
            format: date
        - name: groupId
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: >-
            Native evidence or exact command result. Unavailable evidence is
            explicitly labeled.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StaffingRequirements'
        '400':
          description: Missing or malformed transport fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, invalid or expired bearer
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Saved grant or current authority denied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Scoped resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: Stale source/revision or conflicting request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '413':
          description: Body exceeds 64 KiB
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: Invalid or unsupported input
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Concurrent compute limit; retry after 5 seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Required evidence or service unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    StaffingRequirements:
      type: object
      properties:
        workspace_id:
          type: string
          format: uuid
        group_id:
          type: string
          format: uuid
        from:
          type: string
          format: date
        to:
          type: string
          format: date
        days:
          type: array
          items:
            $ref: '#/components/schemas/RequirementDay'
        evidence_state:
          enum:
            - complete
            - partial
            - unavailable
        missing_days:
          type: integer
          minimum: 0
        units:
          type: object
          properties:
            requiredBySlot:
              const: gross_presence_people
            net:
              const: exact_net_required_people_when_retained
          required: []
          additionalProperties: true
      required:
        - workspace_id
        - group_id
        - from
        - to
        - days
        - evidence_state
        - missing_days
        - units
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    RequirementDay:
      type: object
      properties:
        date:
          type: string
          format: date
        slotMinutes:
          type: number
        openMin:
          type: number
        closeMin:
          type: number
        requiredBySlot:
          type: array
          items:
            type: number
            minimum: 0
          description: Gross presence people.
        computedAt:
          type:
            - string
            - 'null'
          format: date-time
        sourceMode:
          type:
            - string
            - 'null'
        intervalEvidence:
          oneOf:
            - type: 'null'
            - type: object
              properties:
                startTs:
                  type: string
                  format: date-time
                endTs:
                  type: string
                  format: date-time
                intervals:
                  type: array
                  items:
                    $ref: '#/components/schemas/RequirementPortion'
              required:
                - startTs
                - endTs
                - intervals
              additionalProperties: true
        forecastGroupVersionId:
          type:
            - string
            - 'null'
        predictionRunIds:
          type:
            - array
            - 'null'
          items:
            type: string
      required:
        - date
        - slotMinutes
        - openMin
        - closeMin
        - requiredBySlot
        - computedAt
        - intervalEvidence
      additionalProperties: true
    RequirementPortion:
      type: object
      properties:
        startTs:
          type: string
          format: date-time
        endTs:
          type: string
          format: date-time
        requiredPeople:
          type: number
          minimum: 0
          description: Gross presence people, including configured total shrinkage.
        netRequiredPeople:
          type: number
          minimum: 0
          description: >-
            Exact native net demand. Absent on historical evidence; never
            reconstructed from gross.
        residualUnplannedShrinkage:
          type: number
          minimum: 0
          exclusiveMaximum: 1
        residualAssumption:
          enum:
            - no_additional_unplanned_loss
            - explicit_residual_unplanned_loss
      required:
        - startTs
        - endTs
        - requiredPeople
      additionalProperties: true
  securitySchemes:
    AtlasIntegrationBearer:
      type: http
      scheme: bearer
      bearerFormat: atlas_mcp_
      description: >-
        Existing Atlas integration connection with explicit api:connect plus
        appropriate native domain grants. atlas_ingest_ and browser cookies are
        not accepted.

````

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