Ctrl+K

List Network Partners

get/api/network/v1/admin/partners

Lists all OES partners across the entire system. This admin-only endpoint provides a comprehensive view of all partners with complete partner details, regardless of enterprise association. Unlike the client-facing endpoint, this returns full partner information including internal configuration settings.

Query Parameters

  • 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.
  • idsarray[string]
    Filter by specific partner IDs. When provided, only partners with these IDs will be returned.
  • namesarray[string]
    Filter by partner names. When provided, only partners with these names will be returned.
    Min length: >= 1 characters
  • institutionIdsarray[string]
    Filter by institution IDs. When provided, only partners linked to these institutions will be returned.
  • institutionIdentifiersarray[string]
    Filter by institution identifiers. When provided, only partners with these institution identifiers will be returned.
    Min length: >= 1 characters
  • activeboolean
    Filter by active status. When true, only active partners will be returned. When false, only inactive partners will be returned. When not provided, partners of any status will be returned.
  • filterByTrustOrgboolean
    Filter by trust organization. When provided, only partners belonging to this trust organization will be returned.
  • allocationPoliciesEnabledboolean
    Filter by allocation policies enabled. When true, only partners with allocation policies enabled will be returned. When false, only partners with allocation policies disabled will be returned. When not provided, partners with any allocation policies status will be returned.
  • enterpriseIdsarray[string]
    Filter by enterprise IDs. When provided, only partners belonging to these enterprises will be returned.
    Min length: >= 1 characters
  • trustOrgstringRequired
    Trust organization identifier. Used for filtering by the trust organization the partners belong to.
    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

200 Response

partners array[object] required
Array of complete partner objects with all properties.
id string required
enterpriseId string required
Min length: >= 1 characters
trustOrg string required
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
institutionId string
institutionIdentifier string required
Min length: >= 1 characters
name string required
Min length: >= 1 characters
connectionKeySchema string required
Allowed values: token tokenAndSignature apiKeyAndSecret clearloop
createdAt string <date-time>required
Timestamp when the partner was created in the system.
updatedAt string <date-time>required
Timestamp of the most recent update to the partner record.
clientId string required
broker boolean required
active boolean required
settlementTransactionRouteId string
clientDisputeWindowMinutes number
topUpWindowMinutes number
allocationPoliciesEnabled boolean required
publicKey string
Optional RSA public key associated with the partner. This key is used for secure communication and encrypting connection keys. If not supplied, encryption is not required for the partner.

400 Response

401 Response

error string required

403 Response

error string required

500 Response

error string required