---
title: "Get all user terminals"
method: GET
path: "/public/v2/user-terminals"
tags: ["User Terminals"]
---

# Get all user terminals

`GET /public/v2/user-terminals`

Required permission: Device management, View.<br/>Gets all user terminals on the account, filtered by the optional filter parameters, in paginated form

## Query parameters

- `serviceLineNumbers` string[]
- `userTerminalIds` string[]
- `hasServiceLine` boolean
- `searchString` string
- `page` integer

## Response `200`

User terminals retrieved

- UserTerminalResponseV2PaginatedServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean
  - `content` UserTerminalResponseV2Paginated
    - `pageIndex` integer
    - `limit` integer
    - `isLastPage` boolean
    - `results` UserTerminalResponseV2[], nullable
      - `userTerminalId` string — User Terminal ID. This ID is not printed anywhere on the kit or hardware. Example: 00020900-002220cc-225b9199
      - `nickname` string, nullable — Nickname of the user terminal.
      - `kitSerialNumber` string — Kit Serial Number. This ID can be found on the box that the hardware came in. Example: KIT00142069
      - `dishSerialNumber` string — Dish Serial Number. This ID can be found on the dish itself. Example: 2DHT00542069
      - `serviceLineNumber` string, nullable — The service line the user terminal is associated with if it has service, Example: AST-511274-31364-54
      - `l2VpnCircuits` L2VpnCircuitDefinition[] — List of L2VPN circuits and associated VLANs configured for this terminal.
        - `circuitId` string, nullable — Deprecated: Use CircuitIds instead. Value will be first circuitId for redundant circuit groups.
        - `circuitIds` string[], nullable — Starlink generated Ids of L2VPN circuits in this group. If multiple circuitIds are present then they are functioning as a redundant group.
        - `customerVlans` integer[] — Customer VLANs are the inner tag and identify L2VPN customer traffic to and from a user terminal.
        - `serviceVlan` integer, nullable — Outer VLAN tag used for Q-in-Q and identifies a single ethernet virtual circuit (EVC) for a user terminal. Null if no service VLAN configured.
        - `customerVlanRemap` integer, nullable — Traffic tagged with the specified customer VLAN will have that VLAN tag remapped en-route to the value of customerVlanRemap if present. Value is null if no remapping.
      - `routers` RouterResponseV2[] — Routers currently bonded to this UT.
        - `routerId` string — Router Id.
        - `nickname` string, nullable — Nickname of the router.
        - `userTerminalId` string — User terminal Id this router is bonded to.
        - `configId` string, nullable — Router config this router is assigned to, or null if no config assigned.
        - `hardwareVersion` string, nullable — Deprecated field. Value will always be null
        - `lastBonded` string, date-time, nullable — Deprecated field. Value will always be null
    - `totalCount` integer

## Other responses

- `400` — Bad request. Invalid or missing parameter
- `401` — Unauthorized
- `403` — Missing required permission for this endpoint or resource
- `422` — Failed to retrieve user terminals

---

[API](https://skmtc.net/starlink/apis/starlink-management-api.md) · [All operations](https://skmtc.net/starlink/apis/starlink-management-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/starlink/starlink-management-api/revisions/a730bd0ddb42/schema)