Terminals

List Terminals

get/terminals

Request

Query parameters

status'connected' | 'disconnected' | 'unknown' | 'pending_configuration' | 'archived'

filter records by the terminal status. Accepts multiple comma separated status values.

terminal_idstring

filter records by terminal id

provider_idstring

filter records by provider id, also called device id (DID). Accepts multiple comma separated provider ids.

terminal_order_idstring

filter records by terminal order id

verified_afterstring date-time

filter records which were verified after the date and time (UTC) specified. Dates without time specified will default to 00:00:00

verified_beforestring date-time

filter records which were verified before the date and time (UTC) specified. Dates without time specified will default to 00:00:00

verified_onstring date

filter records which were verified on the date specified between 00:00:00 and 23:59:59 (UTC)

Headers

Authorizationstring required

the access_token value returned from the JustiFi oauth/token endpoint (be sure to append Bearer before the token)

Sub-Accountstring

the id of the sub account that this request applies to

Response

Successfully list terminals

idnumber

the object id

typestring

the object type, or array of objects

Example response

{
  "id": 1,
  "type": "array",
  "data": [
    {
      "id": "trm_abc123",
      "account_id": "acc_123xyz",
      "platform_account_id": "acct_789abc",
      "provider": "verifone",
      "status": "disconnected",
      "provider_id": "23456789",
      "provider_serial_number": "888-222-444",
      "nickname": "My Favorite Terminal",
      "verified_at": "2024-01-01T15:00:00Z",
      "model_name": "e285",
      "terminal_order_created_at": "2024-01-01T15:00:00Z",
      "status_last_requested_at": "2024-01-01T15:00:00Z",
      "created_at": "2021-01-01T12:00:00Z",
      "updated_at": "2021-01-01T12:00:00Z"
    }
  ],
  "page_info": {
    "end_cursor": "WyIyMDIyLTAyLTA4IDE5OjUyOjM3LjEwNDE3MzAwMCIsIjY4MDliYTU5LTYxYjctNDg3MS05YWFiLWE2Y2MyNmY3M2M1ZCJd",
    "start_cursor": "WyIyMDIyLTAyLTA4IDIwOjAxOjU4LjEyMDIzMjAwMCIsIjU5ZTFjNGI1LWFlOWQtNDIyZC04MTVkLWNjNzQ5NzdlYmFjYSJd"
  }
}

Changes

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