STstarlink
Managed Accounts

Get managed accounts

Required permission: Managed Account Information, View.<br/>Get managed accounts within your account hierarchy with filtering and pagination support. Returns up to 100 accounts at a time.

get/public/v2/managed/accounts

Request

  • Base URL
    https://starlink.com/api
  • URL
    https://starlink.com/api/public/v2/managed/accounts
  • Auth
    HTTP bearer

Query parameters

ancestorAccountNumberstring

Get accounts under this ancestor account number. Defaults to calling token's account if not provided.

searchStringstring

Filter by account name or number (prefix match)

accountNumbersstring[]

Filter by a set of account numbers

maxDepthinteger

Maximum depth in hierarchy (1 = direct children only, 2 = children + grandchildren, 3 = children through great-grandchildren, etc. null for all descendants.)

cursorstring

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

Response

Managed accounts retrieved

informationstring[] nullable
isValidboolean

Changes

No recorded changes to this operation across all 2 revisions of this API.