Ctrl+K

List transfers

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

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

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 transfers to one or more accounts within the enterprise.
    Example: "aba3a693-4f28-4523-8e53-85a3df22a608"
  • statusarray[string]
    Filter by one or more transfer statuses.
    Example: "completed"
    Enum: processing pending_approval pending completed failed canceled
  • genericAssetstring
    Filter by generic asset identifier.
    Example: btc
    Min length: >= 1 characters
  • fromTypestring
    Filter by source entity type.
    Example: address
    Enum: address bitgo_wallet link_account venue_account
  • toTypestring
    Filter by destination entity type.
    Example: bitgo_wallet
    Enum: address bitgo_wallet link_account venue_account
  • typestring
    Filter by transfer direction relative to the account. "send" returns withdrawals (negative amount), "receive" returns deposits (positive amount).
    Example: send
    Enum: send receive
  • startDatestring<date-time>
    Return transfers created on or after this date (ISO 8601).
    Example: 2024-01-01T00:00:00.000Z
  • endDatestring<date-time>
    Return transfers created on or before this date (ISO 8601).
    Example: 2024-12-31T23:59:59.999Z
  • orderDirectionstringRequired
    Sort direction for sortTimestamp (venue creation time, falls back to ingestion time). Defaults to desc.
    Example: desc
    Enum: asc desc
  • searchLabelstring
    Case-insensitive search across transfer fields: transfer ID, fromId, toId, fromName, and toName.
    Example: abc123
    Min length: >= 1 characters

200 Response

transfers array[object] required
Single transfer response object
id string required
accountId string required
status string required
Allowed values: processing pending_approval pending completed failed canceled
amount string required
Min length: >= 1 characters
genericAsset string
Min length: >= 1 characters
rawAsset string required
Min length: >= 1 characters
rawNetwork string
Min length: >= 1 characters
fromAsset string
Min length: >= 1 characters
fromNetwork string
Min length: >= 1 characters
fromId string
Min length: >= 1 characters
fromType string
Allowed values: address bitgo_wallet link_account venue_account
toAsset string
Min length: >= 1 characters
toNetwork string
Min length: >= 1 characters
toId string
Min length: >= 1 characters
toType string
Allowed values: address bitgo_wallet link_account venue_account
initiatedBy string
Min length: >= 1 characters
fromName string
Min length: >= 1 characters
toName string
Min length: >= 1 characters
fromVenueId string
Min length: >= 1 characters
toVenueId string
Min length: >= 1 characters
cryptoDetail object
Crypto detail response for a transfer
bitgoDetail object
BitGo detail response for a transfer
venueDetail object
Venue detail response for a transfer
sortTimestamp string <date-time>
createdAt string <date-time>required
updatedAt string <date-time>required
total number required
Total number of transfers matching the filter across all pages (same for every page). Use with limit/offset for pagination.

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