Ctrl+K

List addresses

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

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.

Path Parameters

  • enterpriseIdstringRequired
    Your enterprise id.
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
    Min length: >= 1 characters

Query Parameters

  • limitstring or numberRequired
    Maximum number of results to return per page. Defaults to 50.
    Example: 50
  • offsetstring or numberRequired
    Number of results to skip before returning. Defaults to 0.
    Example: 0
  • accountIdsarray[string]
    Filter addresses to one or more accounts within the enterprise.
    Example: "aba3a693-4f28-4523-8e53-85a3df22a608"
  • typestring
    Filter by address type.
    Example: deposit
    Enum: deposit withdrawal
  • statusstring
    Filter by address status.
    Example: active
    Enum: active inactive
  • assetstring
    Filter by asset identifier. Must match the exact value stored in the database (as returned by VAS, e.g. "usdc", "btc").
    Example: usdc
    Min length: >= 1 characters
  • networkstring
    Filter by blockchain network identifier (e.g. "eth", "sol", "bitcoin").
    Example: eth
    Min length: >= 1 characters
  • sortBystringRequired
    Sort field. Defaults to createdDate.
    Example: createdDate
    Enum: createdDate
  • orderDirectionstringRequired
    Sort direction. Defaults to desc (newest first).
    Example: desc
    Enum: asc desc

200 Response

addresses array[object] required
id string required
accountId string required
name string required
Min length: >= 1 characters
type string required
Allowed values: deposit withdrawal
status string required
Allowed values: active inactive
address string required
Min length: >= 1 characters
asset string
Min length: >= 1 characters
network string required
Min length: >= 1 characters
createdDate string <date-time>required
modifiedDate string <date-time>required
total number required

400 Response

401 Response

errorName string required
error string required

403 Response

errorName string required
error string required

500 Response

errorName string required
error string required