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

# Device fleet list + health KPIs

> Device fleet list + health KPIs



## OpenAPI

````yaml /api-reference/openapi.json get /api/devices
openapi: 3.1.0
info:
  title: ontime API
  description: APIs for ontime.v2
  version: 1.0.0
servers:
  - url: https://app.ontime.hosai.app
    description: Production
security:
  - apiKey: []
paths:
  /api/devices:
    get:
      tags:
        - Devices
      summary: Device fleet list + health KPIs
      description: Device fleet list + health KPIs
      operationId: getApiDevices
      parameters:
        - in: query
          name: includeRetired
          schema:
            default: 'false'
            type: string
            enum:
              - 'true'
              - 'false'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  items:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        orgId:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                        deviceId:
                          type: string
                        name:
                          anyOf:
                            - type: string
                            - type: 'null'
                        locationId:
                          anyOf:
                            - type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
                            - type: 'null'
                        locationName:
                          anyOf:
                            - type: string
                            - type: 'null'
                        model:
                          type: string
                        kind:
                          type: string
                          enum:
                            - biometric
                            - kiosk
                        firmware:
                          type: string
                        enrolledCount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        lastSyncAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        status:
                          type: string
                          enum:
                            - Online
                            - Offline
                        retiredAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        punchesToday:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        health:
                          type: string
                          enum:
                            - online
                            - degraded
                            - offline
                            - retired
                      required:
                        - id
                        - orgId
                        - deviceId
                        - name
                        - locationId
                        - locationName
                        - model
                        - kind
                        - firmware
                        - enrolledCount
                        - lastSyncAt
                        - status
                        - retiredAt
                        - punchesToday
                        - health
                  total:
                    type: integer
                    minimum: -9007199254740991
                    maximum: 9007199254740991
                  kpis:
                    type: object
                    properties:
                      total:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      online:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      degraded:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      offline:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      punchesToday:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      syncLagSeconds:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      firmwareOk:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                    required:
                      - total
                      - online
                      - degraded
                      - offline
                      - punchesToday
                      - syncLagSeconds
                      - firmwareOk
                required:
                  - items
                  - total
                  - kpis
components:
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: ont_ API key
      description: >-
        Issue keys in Settings → API. Send them as `Authorization: Bearer ont_…`
        (an `X-Api-Key: ont_…` header is also accepted). Session-cookie routes
        are used by the OnTime web apps and are shown for completeness.

````