<!--
{
  "availability" : [
    "macOS: 15.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "CoreHID",
  "identifier" : "/documentation/CoreHID/HIDDeviceClient/dispatchGetReportRequest(type:id:timeout:)",
  "metadataVersion" : "0.1.0",
  "role" : "Instance Method",
  "symbol" : {
    "kind" : "Instance Method",
    "modules" : [
      "Core HID"
    ],
    "preciseIdentifier" : "s:7CoreHID15HIDDeviceClientC24dispatchGetReportRequest4type2id7timeout10Foundation4DataVAA13HIDReportTypeO_AA0N2IDVSgs8DurationVSgtYaKF"
  },
  "title" : "dispatchGetReportRequest(type:id:timeout:)"
}
-->

# dispatchGetReportRequest(type:id:timeout:)

Send a get report request to the device over the transport.

```
func dispatchGetReportRequest(type: HIDReportType, id: HIDReportID? = nil, timeout: Duration? = nil) async throws -> Data
```

## Parameters

`type`

The [`HIDReportType`](/documentation/CoreHID/HIDReportType) of the requested report.

`id`

The ID of the requested report, determined from the report descriptor. This is unnecessary if the descriptor has only one report.

`timeout`

The maximum amount of time to wait for the device to receive the report before the call times out and fails. Not providing a duration causes the call to wait forever.

## Return Value

The data that the device returned. Reference the device’s [`descriptor`](/documentation/CoreHID/HIDDeviceClient/descriptor) to determine what data the device may respond with.

## Discussion

Many HID devices respond to get report requests to retrieve information from the device. Exactly how a device responds to a get report request is dependent on the device specific implementation, but most devices conform to the reports that they declare in their report [`descriptor`](/documentation/CoreHID/HIDDeviceClient/descriptor). This function throws if the device is seized by another client.

For more details, see [Human Interface Devices (HID) Specifications and Tools](https://www.usb.org/hid).

> Throws: ``doc://com.apple.CoreHID/documentation/CoreHID/HIDDeviceError`` if there is an issue with the request.

---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)