STstarlink
Managed Accounts

Get user terminals across managed accounts

Changed on

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.

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

Query parameters

accountNumbersstring[]

Filter by a set of account numbers. Cannot be used together with accountAncestor

accountAncestorstring

Filter by an ancestor account and all descendants under it. Cannot be used together with accountNumbers

cursorstring

Pagination cursor for fetching next page. Omit parameter for first page

searchStringstring

Filter by partial match of user terminal ID, serial number, or kit serial number

hasServiceLineboolean

Filter by user terminals with or without a services lines. Omitting this will return both sets

serviceLineNumbersstring[]

Filter by a set of service line numbers

Response

User terminals retrieved

informationstring[] nullable
isValidboolean

Changes