---
title: "Get user terminals across managed accounts"
method: GET
path: "/public/v2/managed/accounts/user-terminals"
tags: ["Managed Accounts"]
---

# Get user terminals across managed accounts

`GET /public/v2/managed/accounts/user-terminals`

## Request

- Base URL: `https://starlink.com/api`
- URL: `https://starlink.com/api/public/v2/managed/accounts/user-terminals`
- Auth: HTTP bearer

Required permission: Managed Accounts Inventory Management, View.<br/>Get user terminals within your managed account hierarchy with filtering and pagination support.
Returns a cursor-paginated list of user terminals ordered by user terminal id.

## Query parameters

- `accountNumbers` string[]
- `accountAncestor` string
- `cursor` string
- `searchString` string
- `hasServiceLine` boolean
- `serviceLineNumbers` string[]

## Response `200`

User terminals retrieved

- ManagedAccountUserTerminalResponseKeyPaginatedStringServiceResponse
  - `errors` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `warnings` ValidationResult[], nullable
    - `memberNames` string[], nullable
    - `errorMessage` string, nullable
  - `information` string[], nullable
  - `isValid` boolean
  - `content` ManagedAccountUserTerminalResponseKeyPaginatedString
    - `nextKey` string, nullable: The next key that should be provided to the cursor parameter to fetch the next page, or null if this is the last page.
    - `results` ManagedAccountUserTerminalResponse[]: Results for this page.
      - `accountNumber` string: Account number the user terminal is assigned to. Example: ACC-511274-31364-54
      - `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: SL-DF-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
      - `configId` string, nullable: User terminal config this terminal is assigned to, or null if no config assigned.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Missing required permission for this endpoint or resource
- `422`: Failed to get managed user terminals

## Changes

- **2026-11-02** `dfd7014cfd6d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/starlink/apis/starlink-management-api/changes/public/v2/managed/accounts/user-terminals/get.md)

---

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