<- Devices API

Devices API

List device codes

GET

 /v2/devices/codes

Lists all DeviceCodes associated with the merchant.

Permissions:DEVICE_CREDENTIAL_MANAGEMENT
Try in API Explorer
Link to section

Query parameters

Example code

Link to section

cursor

string

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 for more information.

Link to section

location_id

string

If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty.

Link to section

product_type

string

If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty.

Link to section

status

string

If specified, returns DeviceCodes with the specified statuses. Returns DeviceCodes of status PAIRED and UNPAIRED if empty.

Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Link to section

device_codes

The queried DeviceCode.

Link to section

cursor

string

A pagination cursor to retrieve the next set of results for your original query to the endpoint. This value is present only if the request succeeded and additional results are available.

See Paginating results for more information.