List device codes BETA
Lists all DeviceCodes associated with the merchant.
Query Parameters
| Name | Description |
|---|---|
cursor
|
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. |
location_id
|
If specified, only returns DeviceCodes of the specified location. Returns DeviceCodes of all locations if empty. |
product_type
|
If specified, only returns DeviceCodes targeting the specified product type. Returns DeviceCodes of all product types if empty. |
Response Fields
| Name | Description |
|---|---|
errors
|
Any errors that occurred during the request. |
device_codes
|
The queried DeviceCode. |
cursor
|
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. |
Examples
- cURL
- Ruby
- Python
- C#
- Java
- PHP
curl https://connect.squareup.com/v2/devices/codes \
-H 'Square-Version: 2020-06-25' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json'{
"device_codes": [
{
"id": "B3Z6NAMYQSMTM",
"name": "Counter 1",
"code": "EBCARJ",
"product_type": "TERMINAL_API",
"location_id": "B5E4484SHHNYH",
"created_at": "2020-02-06T18:44:33.000Z",
"pair_by": "2020-02-06T18:49:33.000Z",
"status": "PAIRED",
"device_id": "907CS13101300122",
"status_changed_at": "2020-02-06T18:47:28.000Z"
},
{
"id": "YKGMJMYK8H4PQ",
"name": "Unused device code",
"code": "GVXNYN",
"product_type": "TERMINAL_API",
"location_id": "A6SYFRSV4WAFW",
"pair_by": "2020-02-07T20:00:04.000Z",
"created_at": "2020-02-07T19:55:04.000Z",
"status": "UNPAIRED",
"status_changed_at": "2020-02-07T19:55:04.000Z"
}
]
}