---
title: "Retrieve a terminal"
method: GET
path: "/terminals/{terminalId}"
tags: ["Terminals"]
---

# Retrieve a terminal

`GET /terminals/{terminalId}`

## Request

- Base URL: `https://api.dojo.tech`
- URL: `https://api.dojo.tech/terminals/{terminalId}`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/dojo/apis/dojo-api/docs/terminals/:terminalId/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a terminal by using its ID.

## Path parameters

- `terminalId` string, required

## Headers

- `version` string, date, required
- `software-house-id` string, required
- `reseller-id` string

## Response `200`

OK

- Terminal: The terminal object.
  - `id` string, required: The unique identifier for the terminal.
  - `properties` TerminalProperties, required: Properties related to the terminal.
    - `tid` string, required: An 8-digit identifier printed on receipts.
  - `status` 'Available' | 'Offline' | 'InUse', required: A machine-readable value describing the state of the terminal.
  - `updatedAt` string, date-time, required: The timestamp of the update date, in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) UTC format.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found

---

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