---
title: "Retrieve a list of payment terminals"
method: GET
path: "/api/v1/payment-terminals"
tags: ["Payment Terminals"]
---

# Retrieve a list of payment terminals

`GET /api/v1/payment-terminals`

Required scope: `payment-terminals:read`

## Query parameters

- `page` integer
- `perPage` integer
- `serial` string, nullable — Allows to filter list of terminals by a serial
- `teamId` integer, nullable — Allows to filter list of terminals by a team id.
- `includeDeleted` boolean, nullable — If true, deleted entities will be included in the response.

## Response `200`

List of payment terminals that match the criteria

- OffsetBasedResponse21
  - `data` PaymentTerminal[], required
    - `id` string, required — Id of this terminal. **NOTE: This is a String**
    - `type` 'payter' | 'local' | 'other', required
    - `teamId` integer — The team this terminal belongs to
    - `chargePointIds` integer[], required — The charge points ids this terminal is assigned to
    - `serial` string, required — Serial number of the Payment Terminal
    - `name` string, required — Name given to the Payment Terminal, defaults to "No Name" if not set by the merchant
    - `isConnected` boolean — Indicates if the terminal is connected or disconnected.
    - `connectedAt` string, date-time, nullable — Date this payment terminal did connect
    - `createdAt` string, date-time, required — Date this entity was created
    - `updatedAt` string, date-time, nullable — Date this entity was updated
    - `deletedAt` string, date-time, nullable — Date this entity was deleted
  - `meta` MontaPageMeta, required
    - `itemCount` integer, required
    - `currentPage` integer, required
    - `perPage` integer, required
    - `totalPageCount` integer, required
    - `totalItemCount` integer, required

## Other responses

- `400` — The request is invalid
- `401` — Consumer with provided credentials was not found
- `403` — Operator doesn't have access to resource
- `404` — Entity with the provided id was not found

---

[API](https://skmtc.net/monta/apis/monta-partner-api.md) · [All operations](https://skmtc.net/monta/apis/monta-partner-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/monta/monta-partner-api/versions/517e18f11015/schema)