List Partners

get

https://app.bitgo-test.com/api/network/v1/enterprises/{enterpriseId}/partners

Lists all OES Partners associated with the specified enterprise. Returns a collection of partners with information required to connect to them.

Error scenarios:

400: Invalid Request Error
Occurs when the request parameters are invalid or incomplete.
Examples: Empty string supplied for enterpriseId.
401: Authentication Error
Occurs when the request is not authorized.
Examples: Caller is not a member of the enterprise.
403: Permission Denied Error
Occurs when the authenticated partner doesn't have access to create a partner.
Examples: Enterprise does not have OES license.
500: Internal Server Error
Occurs when there's an unexpected error processing the request
Examples: Database connection failure, transient network error.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

enterpriseId

string

required

length ≥ 1

The enterprise ID of the client making the request.

Query Params

pageNumber

string

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.

pageSize

string

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.

ids

array of strings

Filter by specific partner IDs. When provided, only partners with these IDs will be returned.

ids

names

array of strings

Filter by partner names. When provided, only partners with these names will be returned.

names

institutionIds

array of strings

Filter by institution IDs. When provided, only partners linked to these institutions will be returned.

institutionIds

institutionIdentifiers

array of strings

Filter by institution identifiers. When provided, only partners with these institution identifiers will be returned.

institutionIdentifiers

active

boolean

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.

filterByTrustOrg

boolean

Filter by trust organization. When provided, only partners belonging to this trust organization will be returned.

allocationPoliciesEnabled

boolean

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.

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

500Internal Server Error