# List connected devices

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/setting/connected_device
```

- API version: v1
- Operation ID: `v1_public_connected_device_index`
- Section: Team settings › [Connected devices](https://developer.yoprint.com/reference/connected-devices.md)
- Web page: https://developer.yoprint.com/reference/connected-devices/v1-connected-device-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Returns the devices paired with your team, such as Square terminals for in-person card payments.

`device_status` is `ready` (paired), `unpaired`, `not-found` (gone from Square, or its pairing code expired), `unknown`, or `disabled` for a device that is not a Square terminal. A Square terminal is added with the Square integration's data call (`type: create_device_code`), and its status refreshed with `type: device`.

## Permission

Any member of the team, whatever their role. This is wider than the web app, whose Settings pages need Manage Settings: on the API only changes need it.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/setting/connected_device' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `device_config` (object | array | null, required): The provider's device details as stored, including a Square terminal's pairing `code` and `status` (sensitive; treat as private). Null for AI apps.
    - `device_id` (string | null, required): The provider's id for it: for a Square terminal, the id of its pairing code.
    - `device_name` (string | null, required)
    - `device_status` (string, required): One of: `"ready"`, `"unpaired"`, `"not-found"`, `"unknown"`, `"disabled"`.
    - `device_type` (string, required)
    - `id` (string, required)
    - `is_enabled` (boolean, required)
- `status` (integer, required)
- `success` (boolean, required)

Example response:

```json
{
  "data": [
    {
      "device_config": {
        "code": "ABCDEF",
        "device_id": "device_example_1",
        "id": "device_code_example_1",
        "location_id": "YOUR_SQUARE_LOCATION_ID",
        "name": "Front counter",
        "product_type": "TERMINAL_API",
        "status": "PAIRED",
        "version": "1"
      },
      "device_id": "device_code_example_1",
      "device_name": "Front counter",
      "device_status": "ready",
      "device_type": "square_terminal",
      "id": "fPbIOxwKlAzDsA",
      "is_enabled": true
    }
  ],
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Notes

- `device_config` can hold a terminal's pairing code. Treat it as sensitive.

## Related

- [Remove a connected device](https://developer.yoprint.com/reference/connected-devices/v1-connected-device-destroy.md): `DELETE /v1/api/store/{team_slug}/setting/connected_device/{hash_id}`