List Network Clients

get/api/network/v1/admin/clients

Lists all OES clients.

Query Parameters

  • idsarray[string]
    Optional filter to retrieve specific clients by their UUIDs. Accepts a comma-separated list of client IDs.
  • walletIdsarray[string]
    Optional filter to retrieve clients by their associated wallet IDs. Accepts a comma-separated list of wallet IDs.
    Min length: >= 1 characters
  • enterpriseIdsarray[string]
    Optional filter to retrieve clients belonging to specific enterprises. Accepts a comma-separated list of enterprise IDs.
    Min length: >= 1 characters
  • trustOrgstringRequired
    Trust organization filter for the clients. Only returns clients within the specified trust organization context.
    Enum: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1
  • pageNumberstring<integer>
    The page number (integer) you wish to fetch. When provided, the API will skip pageSize * pageNumber records. Page numbers are zero-based, so the first page is 0. If not provided, defaults to 0.
  • pageSizestring<integer>
    The page size (integer) you wish to fetch. When provided, the API will return at most pageSize records per page. If not provided, a default page size defined by the server will be used.

200 Response

clients array[object] required
Array of complete client objects matching the query criteria.
id string required
The id of the client.
enterpriseId string required
The enterprise ID that this client is associated with.
Min length: >= 1 characters
trustOrg string required
The trust organization that this client is associated with.
Allowed values: BitGo Trust BitGo New York BitGo Germany BitGo Switzerland BitGo Europe ApS Frankfurt DE Trust BitGo Singapore BitGo Korea BitGo Custody MENA FZE BitGo India BitGo Sister Trust 1
walletId string required
The Go Account ID that the client is associated with
Min length: >= 1 characters
createdAt string <date-time>required
The timestamp when the client was created. (ISO 8601 format)
updatedAt string <date-time>required
The timestamp when the client was last updated. (ISO 8601 format)
balanceAlertLastSent string
Last time a balance alert was sent. Typically will be undefined.

400 Response

401 Response

error string required

403 Response

error string required

500 Response

error string required