Appearance

List Accounts ​

Endpoint ​

http
GET /unified/finance/accounts
Integrations supported
  • Akoya
  • Plaid

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified will return the response with unified mappings applied.
  • raw will return the raw response from the remote API.
  • normalized will apply the unified mappings and return the data in a normalized format.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
Example: unified
truto_key_by
string

By default the result attribute is an array of objects. This parameter allows you to specify a field in each result objects to use as key, which transforms the result array into an object with the array items keyed by the field. This is useful for when you want to use the result as a lookup table.

Example: id
truto_ignore_limit
boolean

Ignores the limit query parameter.

truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Response Body ​

result
object[]

List of Accounts

id
string

Unique identifier of the account

Supported in
  • Akoya
  • Plaid
number
string

The account number, usually masked to last 4 digits

Supported in
  • Akoya
  • Plaid
type
string

The primary account type

All possible enum values:
  • investment
  • credit
  • despository
  • loan
  • brokerage
Supported in
  • Akoya
  • Plaid
sub_type
string

Subclassification of the account within the primary account type

Supported in
  • Akoya
  • Plaid
currency
object

Currency used for the account

Supported in
  • Akoya
  • Plaid
id
string

Unique identifier of the currency

code
string

Currency code

name
string

Human readable currency name

name
string

Name of the account

Supported in
  • Akoya
  • Plaid
description
string

Short description of the account

Supported in
  • Akoya
product
object

The product that the account is an instance of

Supported in
  • Akoya
  • Plaid
id
string

Unique identifier of the product

name
string

Human readable name of the product

status
object

Status of the account

Supported in
  • Akoya
id
string

Unique identifier of the status

name
string

Name of the status

created_at
string · date-time

The date and time when the account was created

Supported in
  • Akoya
updated_at
string · date-time

The date and time when the account was last updated

Supported in
  • Akoya
  • Plaid
remote_data
object

Raw data returned from the remote API call.

next_cursor
string

The cursor to use for the next page of results. Pass this value as next_cursor in the query parameter in the next request to get the next page of results.