FileMaster

Edit File: list-device-codes-request.md

# List Device Codes Request

## Structure

`ListDeviceCodesRequest`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](https://developer.squareup.com/docs/working-with-apis/pagination) for more information. | getCursor(): ?string | setCursor(?string cursor): void |
| `locationId` | `?string` | Optional | If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty. | getLocationId(): ?string | setLocationId(?string locationId): void |
| `productType` | [`?string(ProductType)`](../../doc/models/product-type.md) | Optional | - | getProductType(): ?string | setProductType(?string productType): void |
| `status` | [`?(string(DeviceCodeStatus)[])`](../../doc/models/device-code-status.md) | Optional | If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status `PAIRED` and `UNPAIRED` if empty. See [DeviceCodeStatus](#type-devicecodestatus) for possible values | getStatus(): ?array | setStatus(?array status): void |

## Example (as JSON)

```json
{
  "cursor": "cursor6",
  "location_id": "location_id4",
  "product_type": "TERMINAL_API",
  "status": [
    "UNKNOWN",
    "UNPAIRED",
    "PAIRED"
  ]
}
```

Back