DOdojo
Terminals

Retrieve all terminals

Allows you to retrieve details of all terminals.

get/terminals

Request

Query parameters

statusesTerminalStatus[]

A machine-readable value describing the state of the terminal. Terminals with any of the statuses provided in this parameter will be listed.

Headers

versionstring date required

The API version with format yyyy-mm-dd. The current version is 2026-02-27.

software-house-idstring required

This field shows the EPOS company whose software is generating the request. This value should not be configurable as it will remain the same for all customers using particular EPOS software.

reseller-idstring

This identifies the reseller of the EPOS. This may be the same as the software-house-id if they are also the seller.

Response

A list of terminals.

idstring required

The unique identifier for the terminal.

status'Available' | 'Offline' | 'InUse' required

A machine-readable value describing the state of the terminal.

updatedAtstring date-time required

The timestamp of the update date, in ISO 8601 UTC format.

Example response

[
  {
    "id": "tm_sandbox_amxm22C23",
    "properties": {
      "tid": "12345678"
    }
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.