Sign in
Link Transfers

List transfers

Lists transfers for an enterprise with filtering, pagination, and sorting.

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

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 transfers to one or more accounts within the enterprise.

[
  "\"aba3a693-4f28-4523-8e53-85a3df22a608\""
]
statusstring[]

Filter by one or more transfer statuses.

[
  "\"completed\""
]
genericAssetstring[]

Filter by one or more generic asset identifiers.

[
  "\"btc\""
]
fromType'address' | 'bitgo_wallet' | 'link_account' | 'venue_account'
Example:address

Filter by source entity type.

toType'address' | 'bitgo_wallet' | 'link_account' | 'venue_account'
Example:bitgo_wallet

Filter by destination entity type.

type'send' | 'receive'
Example:send

Filter by transfer direction relative to the account. "send" returns withdrawals (negative amount), "receive" returns deposits (positive amount).

startDatestring date-time
Example:2024-01-01T00:00:00.000Z

Return transfers created on or after this date (ISO 8601).

endDatestring date-time
Example:2024-12-31T23:59:59.999Z

Return transfers created on or before this date (ISO 8601).

'asc' | 'desc' required

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

OR
'desc' required

Sort direction for sortTimestamp (venue creation time, falls back to ingestion time). Defaults to desc.

searchLabelstring
Example:abc123

Case-insensitive search across transfer fields: transfer ID, fromId, toId, fromName, and toName.

toAddressstring
Example:TQrZ9wBLXKnNF8WiyQqMnxQyG3MJC4mYQv

Filter to transfers whose on-chain destination address matches this value (exact match). Joins through the crypto-detail relation; transfers without a crypto detail are excluded when this filter is set.

Headers

user-idstring required

User id of the user making the request.

Response

OK

totalnumber required

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

Changes

Changed in 3 of the 33 revisions of this API.24

  • 3d2da605821b2See the full diff
    • ○

      for the query request parameter genericAsset, the minLength was decreased from 1 to 0

      request-parameter-min-length-decreased

    • ○

      for the query request parameter genericAsset, the type was generalized from string to array

      request-parameter-type-generalized

  • a7126d55243d21See the full diff
    • ▲

      removed the enum value asc from the query request parameter orderDirection

      request-parameter-enum-value-removed

    • ▲

      removed the enum value desc from the query request parameter orderDirection

      request-parameter-enum-value-removed

    • ○

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

      request-parameter-type-generalized

  • 996b41eb18181See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added