Sign in
Link Accounts

List Link accounts

Lists Link accounts for an enterprise with filtering, pagination, and sorting.

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

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.

venueIdstring
Example:COINBASE_EXCHANGE

Filter accounts by venue identifier.

namestring
Example:My Coinbase

Filter accounts by name (case-insensitive partial match).

descriptionstring
Example:trading

Filter accounts by description (case-insensitive partial match).

statusstring[]

Filter by one or more account statuses.

[
  "\"active\""
]
sortBy'name' | 'createdDate' required
Example:name

Sort field. Defaults to name.

orderDirection'asc' | 'desc' required
Example:asc

Sort direction. Defaults to asc.

Headers

user-idstring required

User id of the user making the request.

Response

OK

totalnumber required

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

Changes

Changed in 1 of the 17 revisions of this API.21

  • 37833ced534621See the full diff
    • ●

      added the new restricted enum value to the accounts/items/allOf[subschema #1]/subAccounts/items/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new restricted enum value to the accounts/items/allOf[subschema #2: V1AccountResponse]/status response property for the response status 200

      response-property-enum-value-added

    • ○

      added the enum value restricted to the property items/ of the query request parameter status

      request-parameter-property-enum-value-added