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

# List Devices

> Retrieve a list of devices



## OpenAPI

````yaml Get /v1/devices/
openapi: 3.1.0
info:
  title: ManageXR API
  description: API documentation for ManageXR
  version: 1.0.0
servers:
  - url: https://managexrapi.com
    description: ManageXR API Server
security:
  - basicAuth: []
paths:
  /v1/devices/:
    get:
      summary: List devices
      description: Retrieve a list of devices
      parameters:
        - name: organizationId
          in: query
          required: false
          schema:
            type: string
          description: >
            Unique identifier of the organization. This parameter is only
            necessary when using multi-organization API keys. 


            Defaults to the organizationId associated with the API key.
        - name: names
          in: query
          required: false
          schema:
            type: string
          description: >-
            Query by device name. Allows partial matching. Separate multiple
            name parameters by comma.
        - name: serials
          in: query
          required: false
          schema:
            type: string
          description: >-
            Query by device serial. Allows partial matching. Separate multiple
            serial parameters by comma.
        - name: configurations
          in: query
          required: false
          schema:
            type: string
          description: >-
            Query by configuration unique identifier. Separate multiple
            configuration id parameters by comma.
        - name: tags
          in: query
          required: false
          schema:
            type: string
          description: >-
            Query by tag unique identifier. Separate multiple tag id parameters
            by comma.
        - name: models
          in: query
          required: false
          schema:
            type: string
          description: Query by model name. Separate multiple model parameters by comma.
        - name: manufacturers
          in: query
          required: false
          schema:
            type: string
          description: >-
            Query by manufacturer name. Separate multiple manufacturer
            parameters by comma.
        - name: firmwareVersions
          in: query
          required: false
          schema:
            type: string
          description: >-
            Query by firmware version. Separate multiple firmware version
            parameters by comma.
        - name: filters
          in: query
          required: false
          schema:
            type: string
            enum:
              - online
              - offline
              - upToDate
              - outOfDate
              - updateError
              - updating
              - paused
              - lowBattery
              - activeToday
              - activeWeek
              - activeMonth
              - activeOther
              - factoryResetPending
              - factoryReset
          description: Query by filter.
      responses:
        '200':
          description: A list of devices
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/V1Device'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 403
                  message:
                    type: string
                    example: Forbidden
                  error:
                    type: string
                    example: ManageXR Error
              example:
                statusCode: 403
                message: Forbidden
                error: ManageXR Error
        '404':
          description: Device not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  statusCode:
                    type: number
                    example: 404
                  message:
                    type: string
                    example: Not found
                  error:
                    type: string
                    example: ManageXR Error
              example:
                statusCode: 404
                message: Not found error
                error: ManageXR Error
components:
  schemas:
    V1Device:
      type: object
      description: Full representation of a device managed in ManageXR
      properties:
        id:
          type: string
          description: The device ID (serial number)
          example: '12345678901234'
        serial:
          type: string
          description: Device serial number
          example: '12345678901234'
        name:
          type: string
          description: The device name
          example: Training Room 1
        mac:
          type: string
          description: MAC address of the device
          example: CE:AF:07:47:E0:AE
        model:
          type: string
          description: The device model
          example: Quest 2
        manufacturer:
          type: string
          description: The device manufacturer
          example: Meta
        notes:
          type: string
          description: Optional user-provided notes about the device
          example: Mounted in Room 5
        batteryLevel:
          type: number
          description: Battery level percentage
          example: 87
        batteryIsCharging:
          type: boolean
          description: Whether the device is currently charging
          example: true
        pauseUpdates:
          type: boolean
          description: Whether updates are paused for this device
          example: false
        online:
          type: boolean
          description: Whether the device is currently online
          example: true
        osVersion:
          type: string
          description: The OS version running on the device
          example: Android 12
        outOfDate:
          type: boolean
          description: Whether the device is running outdated software
          example: true
        registerDate:
          type: string
          format: date-time
          description: The date this device was registered with ManageXR
          example: '2023-11-12T10:30:00Z'
        updating:
          type: boolean
          description: Whether the device is currently performing an update
          example: false
        factoryResetStatus:
          type: string
          description: Status of any pending or active factory reset
          example: NONE
        firmwareVersion:
          type: string
          description: Firmware version reported by the device
          example: Oculus OS 46.0.0.230
        configuration:
          type: object
          description: The configuration assigned to this device
          properties:
            id:
              type: string
              example: sFidGmedeQofSBcvRcyn
            name:
              type: string
              example: Training Configuration
        tags:
          type: array
          description: Tags assigned to this device
          items:
            type: object
            properties:
              id:
                type: string
                example: tag_abc123
              name:
                type: string
                example: Lab Devices
        tutorialModeEnabled:
          type: boolean
          description: Whether tutorial mode is enabled
          example: false
        kioskModeOverride:
          type: boolean
          description: >-
            True if device has Kiosk Mode/ManageXR Home Screen disabled. When
            true, the device is not locked into the ManageXR Home Screen or
            Kiosk App and users have full access to the native system menus.
            [Learn
            more](https://help.managexr.com/en/articles/5416931-temporarily-disable-kiosk-mode-home-screen)
          example: true
        lastSync:
          type: string
          format: date-time
          description: >-
            The last time the device checked in with ManageXR. Online devices
            check in every 15 minutes.
          example: '2024-04-20T17:23:12Z'
        ram:
          type: object
          description: RAM usage info
          properties:
            available:
              type: number
              description: Available RAM in bytes
              example: 2147483648
            total:
              type: number
              description: Total RAM in bytes
              example: 4294967296
        storage:
          type: object
          description: Internal storage usage info
          properties:
            available:
              type: number
              description: Available storage in bytes
              example: 15728640000
        location:
          type: object
          description: Approximate location of the device
          properties:
            city:
              type: string
              example: San Francisco
            region:
              type: string
              example: California
            country:
              type: string
              example: US
            continent:
              type: string
              example: North America
            timeZone:
              type: string
              example: America/Los_Angeles
            longitude:
              type: number
              example: -122.4194
            latitude:
              type: number
              example: 37.7749
        connectedWifiNetwork:
          type: object
          description: Current connected Wi-Fi network
          properties:
            ssid:
              type: string
              example: ManageXR-Office
        currentForegroundApp:
          type: object
          description: Currently running app in the foreground
          properties:
            packageName:
              type: string
              example: com.my.app
            title:
              type: string
              example: My Training App
        controllerData:
          type: object
          description: Data about connected controllers
          properties:
            controller0:
              type: object
              properties:
                batteryLevel:
                  type: number
                  example: 85
                version:
                  type: string
                  example: v14
            controller1:
              type: object
              properties:
                batteryLevel:
                  type: number
                  example: 82
                version:
                  type: string
                  example: v14
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >
        API key based authentication where <encoded-value> is the Base64
        encoding of `API_KEY_ID`:`API_KEY_SECRET`

        - **Username**: The API Key ID.

        - **Password**: The API Key Secret.

````