> ## 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 compatible coverage evidence

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



## OpenAPI

````yaml /api-reference/workforce/openapi.json get /api/v1/workforce/scheduling-groups/{groupId}/coverage
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}/coverage:
    get:
      summary: Read compatible coverage evidence
      description: >-
        Read coverage evidence for a scheduling group over the requested date
        range.
      operationId: get_workforce_coverage
      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: preview
          in: query
          schema:
            type: string
            enum:
              - draft
        - 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/Coverage'
        '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:
    Coverage:
      type: object
      properties:
        unscheduled_dates:
          type: array
          items:
            type: string
            format: date
        days:
          type: array
          items:
            $ref: '#/components/schemas/CoverageDay'
      required:
        - unscheduled_dates
        - days
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false
    CoverageDay:
      type: object
      additionalProperties: true
      properties:
        date:
          type: string
          format: date
        state:
          type: string
          enum:
            - sufficient
            - critical
            - full
            - uncovered
            - unknown
        reason_codes:
          type: array
          items:
            type: string
        supply_basis:
          type: string
        requirement_basis:
          type:
            - string
            - 'null'
        productive_people_by_interval:
          type:
            - array
            - 'null'
          items:
            type: number
        effective_productive_people_by_interval:
          type:
            - array
            - 'null'
          items:
            type: number
        net_required_people_by_interval:
          type:
            - array
            - 'null'
          items:
            type: number
        demand_timeline:
          type:
            - array
            - 'null'
          items:
            type: object
            properties:
              start_ts:
                type: string
                format: date-time
              end_ts:
                type: string
                format: date-time
              net_required_people:
                type: number
              residual_unplanned_shrinkage:
                type: number
                minimum: 0
                exclusiveMaximum: 1
              productive_people:
                type: number
              effective_productive_people:
                type: number
              net_people:
                type: number
            required:
              - start_ts
              - end_ts
              - net_required_people
              - residual_unplanned_shrinkage
              - productive_people
              - effective_productive_people
              - net_people
        assessment:
          type: string
          enum:
            - assessed
            - not_assessed
            - not_applicable
          description: >-
            Missing exact net or residual evidence is not_assessed, never
            positive coverage. Physical supply remains available; demand facts
            are null.
      required:
        - date
        - state
        - reason_codes
        - supply_basis
        - requirement_basis
        - demand_timeline
        - assessment
  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.