Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Devices

List Devices

Retrieve a list of Devices.

For details on how to query endpoints using the available parameters, see Query Parameters.

get/devices

Query parameters

after_cursorstring

Return every resource created after the cursor value.

application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

descriptionstring

Filter by the description.

enabledboolean
Example:true

Filter by the enabled value.

limitinteger
Example:10

The numbers of items to return.

merchant_idstring
Example:MUeDVrf2ahuKc9Eg5TeZugvs

Filter by Merchant ID.

merchant_identity_idstring
Example:IDtEnKsZyJNUGK83ZTx4C45S

Filter by Merchant Identity ID.

namestring
Example:john%%20smith

Filter by the name.

modelstring
Example:PAX_A800

Filter by the model.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

serial_numberstring
Example:2210074802

Filter by the serial number.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Device resources

Example response

{
  "_embedded": {
    "devices": [
      {
        "merchant": "MUxxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}