REST API›Link›Link Addresses

GET

List 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 Params

  • enterpriseId string required
    Your enterprise id.

    at least 1 characters · matches ^[0-9a-f]{32}$

Query Params

  • limit string or number required
    Maximum number of results to return per page. Defaults to 50.

    ONE OF

    string
  • offset string or number required
    Number of results to skip before returning. Defaults to 0.

    ONE OF

    string
  • accountIds array of strings
    Filter addresses to one or more accounts within the enterprise.
  • type string enum
    Filter by address type.
    depositwithdrawal
  • status string enum
    Filter by address status.
    activeinactive
  • asset string
    Filter by asset identifier (e.g. "usdc", "btc").

    at least 1 characters

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

    at least 1 characters

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

    at least 1 characters

  • sortBy string enum required
    Sort field. Defaults to createdDate.
    createdDate
  • orderDirection string required
    Sort direction. Defaults to desc (newest first).

    ONE OF

    string enum

Header Params

  • user-id string required
    User id of the user making the request.

    at least 1 characters

Responses

200
OK

Response Body

object

  • addresses array of objects required
    addresses object
    • id string required
    • accountId string required
    • name string required

      at least 1 characters

    • type string enum required
      depositwithdrawal
    • status string enum required
      activeinactive
    • address string required

      at least 1 characters

    • asset string

      at least 1 characters

    • genericAsset string

      at least 1 characters

    • network string required

      at least 1 characters

    • tag string

      at least 1 characters

    • createdDate string date-time required
    • modifiedDate string date-time required
  • total number required
400
Bad Request
No response body
401
Unauthorized

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
403
Forbidden

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required
500
Internal Server Error

Response Body

object

Standard structured error response payload for Link API v1 error responses. Contains an error name and human-readable error message.
  • errorName string required
  • error string required