---
title: "Get Device List Under Organization"
method: GET
path: "/openapi/v2.0/device"
tags: ["Device Management/Device List Management/Device List (Organization Scope)", "Organization & Project", "device-api"]
---

# Get Device List Under Organization

`GET /openapi/v2.0/device`

## Request

- Base URL: `` (relative, and it does not resolve against the document’s source URL)
- URL: `/openapi/v2.0/device`
- Auth: API key in header `X-User-Token`

Get the device list under the organization for the 'Dock Scene'. Set the user key through the `X-User-Token` parameter in the `Header`; this interface will return the list of all devices under the organization corresponding to the user key.
:::tip[]
- Use gateway: `camera_list` to obtain dock camera info, usable for Device Management: `Dock Camera Switch`.
- Use drone: `camera_list` to obtain aircraft camera info, usable for Device Management: `Aircraft Lens Switch`.
- `camera_list` is available only after the aircraft is powered on.
- Currently returns information for up to 1000 devices.
:::

## Query parameters

- `device_model_class` 'drone' | 'airport'

## Headers

- `X-Request-Id` string, uuid
- `X-Language` 'zh' | 'en'
- `X-Project-Uuid` string, required
- `X-User-Token` string, required

## Response `200`

- object
  - `code` integer, required: Non-zero Indicates Exception
  - `message` string, required: Message Prompt
  - `data` object, required: Business Data
    - `list` object[], required: Device List
      - `gateway` object: Gateway List
        - `sn` string, required: Device SN
        - `callsign` string, required: Device Alias
        - `device_model` object, required: Device Model
          - `key` string, required: Key, device unique identifier composed of domain-type-sub_type. For detailed device types, refer to: https://developer.dji.com/doc/cloud-api-tutorial/en/overview/product-support.html
          - `domain` string, required: Domain
          - `type` string, required: Type
          - `sub_type` string, required: Sub-Type
          - `name` string, required: Device Model
          - `class` string, required: Device Category: Dock, Remote Controller, etc.
        - `device_online_status` boolean, required: Device Online Status
        - `mode_code` integer, required: Device status: {"0":"Idle","1":"On-Site Debugging","2":"Remote Debugging","3":"Firmware Upgrading","4":"In Operation"}
        - `camera_list` object[], required: Camera List
          - `camera_index` string: Camera Index
          - `available_camera_positions` string[]: Available Camera Positions
          - `camera_position` 'indoor' | 'outdoor': Current Camera Position
      - `drone` object: Aircraft List
        - `sn` string, required: Aircraft SN
        - `callsign` string, required: Device Alias
        - `device_model` object, required: Device Model
          - `key` string, required: Key, device unique identifier composed of domain-type-sub_type. For detailed device types, refer to: https://developer.dji.com/doc/cloud-api-tutorial/en/overview/product-support.html
          - `domain` string, required: Domain
          - `type` string, required: Type
          - `sub_type` string, required: Sub-Type
          - `name` string, required: Device Model
          - `class` string, required: Device Category: Aircraft
        - `device_online_status` boolean, required: Device Online Status
        - `mode_code` integer, required: Aircraft status: {"0":"Standby","1":"Takeoff Preparation","2":"Takeoff Preparation Complete","3":"Manual Flight","4":"Automatic Takeoff","5":"Wayline Flight","6":"Panorama Photo","7":"Intelligent Follow","8":"ADS-B Avoidance","9":"Automatic Return-to-Home","10":"Automatic Landing","11":"Forced Landing","12":"Three-Blade Landing","13":"Upgrading","14":"Disconnected","15":"APAS","16":"Virtual Joystick State","17":"Command Flight","18":"In-Air RTK Convergence Mode","19":"Dock Site Selection"}
        - `camera_list` object[], required: Camera List
          - `camera_index` string: Camera Index
          - `lens_list` object[]: Lens List
            - `available_lens_types` string[]: Available Lens List
            - `lens_type` 'normal' | 'wide' | 'zoom' | 'ir': Current Lens Type

## Other responses

- `400`: Invalid request parameters (incorrect format, missing required fields, etc.)
- `401`: Authentication failed (token invalid or expired)
- `403`: Insufficient permission (token does not have the corresponding permission in this project/organization)
- `500`: Server Internal Error

---

[API](https://skmtc.dev/dji/apis/flighthub-2-openapi-v2-0-public-cloud.md) - [All operations](https://skmtc.dev/dji/apis/flighthub-2-openapi-v2-0-public-cloud/llms.txt) - [OpenAPI document](https://skmtc.dev/dji/apis/flighthub-2-openapi-v2-0-public-cloud/revisions/aeef0010be34?raw)
