Link Addresses

List addresses

Changed on

Returns a paginated list of addresses for the enterprise. Results are scoped to the caller's link.account.view permission. Supports filtering by accountIds, type, status, asset, and network.

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

Request

  • Base URL
    https://developers.bitgo.com
  • URL
    https://developers.bitgo.com/api/link/v1/enterprises/{enterpriseId}/addresses
  • 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.

accountIdsstring[]

Filter addresses to one or more accounts within the enterprise.

[
  "\"aba3a693-4f28-4523-8e53-85a3df22a608\""
]
type'deposit' | 'withdrawal'
Example:deposit

Filter by address type.

status'active' | 'inactive'
Example:active

Filter by address status.

assetstring
Example:usdc

Filter by asset identifier (e.g. "usdc", "btc").

genericAssetstring
Example:usdc

Filter by network-agnostic asset identifier (e.g. "usdc", "btc").

networkstring
Example:eth

Filter by blockchain network identifier (e.g. "eth", "sol", "bitcoin").

sortBy'createdDate' required
Example:createdDate

Sort field. Defaults to createdDate.

'asc' | 'desc' required

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

OR
'desc' required

Sort direction. Defaults to desc (newest first).

Headers

user-idstring required

User id of the user making the request.

Response

OK

totalnumber required

Changes

  • a7126d55243dRevision changes
    • breaking

      removed the enum value asc from the query request parameter orderDirection

    • breaking

      removed the enum value desc from the query request parameter orderDirection

    • info

      for the query request parameter orderDirection, the type was generalized from string to no type