---
title: "List Terminals"
method: GET
path: "/terminals"
tags: ["Terminals"]
---

# List Terminals

`GET /terminals`

## Request

- Base URL: `https://api.justifi.ai/v1`
- URL: `https://api.justifi.ai/v1/terminals`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/justifi/apis/justifi-api-documentation/docs/terminals/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `status` 'connected' | 'disconnected' | 'unknown' | 'pending_configuration' | 'archived'
- `terminal_id` string
- `provider_id` string
- `terminal_order_id` string
- `verified_after` string, date-time
- `verified_before` string, date-time
- `verified_on` string, date

## Headers

- `Authorization` string, required
- `Sub-Account` string

## Response `200`

Successfully list terminals

- object
  - `id` number: the object id
  - `type` string: the object type, or array of objects
  - `data` Terminal[]: the list of objects
    - `id` string: unique terminal id
    - `account_id` string, uuid: id of the account associated with the terminal
    - `platform_account_id` string, uuid: id of the platform account associated with the terminal
    - `provider` string: terminal provider
    - `status` string: last known terminal status. For performance reasons, this field is only updated when you check the terminal status via API.
    - `provider_id` string: terminal identification from provider, also called device id (DID)
    - `provider_serial_number` string: serial number of the terminal device. Present after device was configured by entering the provider id (also called device id) into device.
    - `nickname` string: terminal custom identification, can be added and modified via update terminal API
    - `verified_at` string, date-time
    - `model_name` string: name of terminal device model
    - `terminal_order_created_at` string, date-time: timestamp of when the terminal order was placed
    - `status_last_requested_at` string, date-time: timestamp of last terminal status request
    - `created_at` string, date-time
    - `updated_at` string, date-time
  - `page_info` PageInfo
    - `end_cursor` string: the encoded id of the last record in the current list
    - `has_next` boolean: true if the collection contains records following the current list
    - `has_previous` boolean: true if the collection contains records ahead of the current list
    - `start_cursor` string: the encoded id of the first record in the current list

---

[API](https://skmtc.dev/justifi/apis/justifi-api-documentation.md) - [All operations](https://skmtc.dev/justifi/apis/justifi-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/justifi/apis/justifi-api-documentation/revisions/dd9f3fed7e46?raw)