---
title: "Search devices"
method: GET
path: "/devices"
tags: ["Devices"]
---

# Search devices

`GET /devices`

Use this method to return a [paginated](https://docs.payroc.com/api/pagination) list of devices associated with a merchant's API key or an ISV's API key.  

Use the query parameters to filter the list of results that we return, for example, to search for devices by their model.  

Our gateway returns the following information about each device in the list:  

- Unique identifier that we assigned to the device.
- Serial number of the device.
- Key serial identifier (KSI) of the device.
- Device model or type of device.
- Date that our gateway added the device to our systems.
- Information about the last transaction that the device processed.

## Query parameters

- `before` string
- `after` string
- `limit` integer
- `active` boolean
- `serialNumber` string
- `ksi` string
- `model` string

## Headers

- `Authorization` string, required

## Response `200`

Successful request. Returns a list of devices associated with the API key.

- DevicePaginatedList
  - `limit` integer, required — Maximum number of results that we return for each page.
  - `count` integer, required — Number of results we returned on this page. **Note:** This might not be the total number of results that match your query.
  - `hasMore` boolean, required — Indicates whether there is another page of results available.
  - `links` Link[] — Reference links to navigate to the previous page of results or to the next page of results.
    - `rel` string, required — Indicates the relationship between the current resource and the target resource.
    - `method` string, required — HTTP method that you need to use with the target resource.
    - `href` string, required — URL of the target resource.
  - `data` DevicePaginatedListDataItems[], required — Array of device objects. Each object contains information about a device.
    - `deviceId` string — Unique identifier that we assigned to the device.
    - `tender` 'creditDebit' | 'ebt' — Payment methods accepted by the device. - `creditDebit` – Credit and debit card payments. - `ebt` – Electronic Benefit Transfer (EBT) payments.
    - `serialNumber` string — Serial number of the device.
    - `ksi` string — Key serial identifier (KSI) of the device.
    - `createdDate` string, date-time — Date and time that our gateway added the device to our systems. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
    - `deactivatedDate` string, date-time — Date and time that we deactivated the device. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. **Note:** If the device is active, our gateway doesn't return a value for `deactivatedDate`.
    - `deviceType` DevicePaginatedListDataItemsDeviceType — Object that contains information about the device.
      - `model` string — Model or type of the device.
      - `manufacturer` string — Company that manufactured the device.
    - `lastTransaction` DevicePaginatedListDataItemsLastTransaction — Object that contains information about the last transaction that the device processed.
      - `orderId` string — Unique identifier that the merchant assigned to the order.
      - `dateTime` string, date-time — Date and time that the processing terminal processed the last transaction. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
      - `processingTerminalId` string — Unique identifier that we assigned to the processing terminal.
    - `links` Link[]
      - `rel` string, required — Indicates the relationship between the current resource and the target resource.
      - `method` string, required — HTTP method that you need to use with the target resource.
      - `href` string, required — URL of the target resource.

## Other responses

- `400` — Invalid request
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `406` — Not acceptable
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)