Ctrl+K

List Link accounts

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

Lists Link accounts 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
  • venueIdstring
    Filter accounts by venue identifier.
    Example: COINBASE_EXCHANGE
    Min length: >= 1 characters
  • namestring
    Filter accounts by name (case-insensitive partial match).
    Example: My Coinbase
    Min length: >= 1 characters
  • descriptionstring
    Filter accounts by description (case-insensitive partial match).
    Example: trading
    Min length: >= 1 characters
  • statusarray[string]
    Filter by one or more account statuses.
    Example: "active"
    Enum: active inactive deleted pending_credentials
  • sortBystringRequired
    Sort field. Defaults to name.
    Example: name
    Enum: name createdDate
  • orderDirectionstringRequired
    Sort direction. Defaults to asc.
    Example: asc
    Enum: asc desc

200 Response

accounts array[object] required
subAccounts array[object]
id string required
venueId string required
Min length: >= 1 characters
credentials array[object] required
status string required
Allowed values: active inactive deleted pending_credentials
name string required
Min length: >= 1 characters
description string required
Min length: >= 1 characters
whitelistingEnabled boolean required
parentAccount string
users array[object]
createdDate string <date-time>required
modifiedDate string <date-time>required
total number required
Total number of accounts 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

500 Response

errorName string required
error string required