Link Accounts

List Link accounts

Changed on

Lists Link accounts for an enterprise with filtering, pagination, and sorting.

get/api/link/v1/enterprises/{enterpriseId}/accounts

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/link/v1/enterprises/{enterpriseId}/accounts
  • Auth
    none declared. Required headers: user-id

Path parameters

enterpriseIdstring required
Example:59cd72485007a239fb00282ed480da1f

Your enterprise id.

Query parameters

string required
OR
50 required

Maximum number of results to return per page. Defaults to 50.

string required
OR
0 required

Number of results to skip before returning. Defaults to 0.

venueIdstring
Example:COINBASE_EXCHANGE

Filter accounts by venue identifier.

namestring
Example:My Coinbase

Filter accounts by name (case-insensitive partial match).

descriptionstring
Example:trading

Filter accounts by description (case-insensitive partial match).

statusstring[]

Filter by one or more account statuses.

[
  "\"active\""
]
sortBy'name' | 'createdDate' required
Example:name

Sort field. Defaults to name.

'asc' | 'desc' required

io-ts codec for sort direction (asc or desc).

OR
'asc' required

Sort direction. Defaults to asc.

Headers

user-idstring required

User id of the user making the request.

Response

OK

totalnumber required

Total number of accounts matching the filter across all pages (same for every page). Use with limit/offset for pagination.

Changes