List all Devices

This endpoint returns a list of Devices. This endpoint can be returned. Some Devices will only appear for certain types of Users if they are in a particular state. For example, when a KIF user makes this API call, a Device will be included in the response list if its deviceState is set to 'Unassigned', 'Assigned', or 'Injected'. Once it is received by the merchant and its deviceState is set to 'Stored' or 'Activating', the Device will no longer appear on the GET all devices response for the KIF user.

The list of Devices can be filtered by the Partner, Client, KIF, and the Device's state. Use the 'skip' and 'take' parameters to implement pagination.

Query Params
string

Filter the list by Partner. The parameter value can be either a Partner ID or Name.

string

Filter the list by Client. The parameter value can be either a Client ID or Name.

string

Filter the list by KIF. The parameter value can be either a KIF ID or Name.

string

Filter the list by a comma separated list of serial numbers.

string
enum

Filter the list by Device State.

int32
Defaults to 10

The number of entries to include in the list.

int32
Defaults to 0

The number of results to skip before listing entries.

string
enum
Defaults to serialnumber

The field to order the Device list.

string
enum
Defaults to asc

The direction to sort the Device list.

Allowed:
Responses

Language
Credentials
Basic
base64
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json