API Reference

Accounts

List accounts

accounts().list(AccountListParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : List<Account>

GET/api/v1/accounts

List accounts

ParametersExpand Collapse

params: AccountListParams

userId: String

formatuuid

List accounts

Kotlin

unfold_more

TypeScript

Java

Kotlin

Go

C#

package com.rails.api.example

import com.rails.api.client.RailsClient
import com.rails.api.client.okhttp.RailsOkHttpClient
import com.rails.api.models.accounts.Account
import com.rails.api.models.accounts.AccountListParams

fun main() {
    val client: RailsClient = RailsOkHttpClient.fromEnv()

    val params: AccountListParams = AccountListParams.builder()
        .userId("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e")
        .build()
    val accounts: List<Account> = client.accounts().list(params)
}

200 example

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_number": "account_number",
    "account_type": "checking",
    "balance": "balance",
    "currency": "currency",
    "environment": "environment",
    "status": "active",
    "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "admin_user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "user_role": "user_role"
  }
]

Returns Examples

200 example

[
  {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "account_number": "account_number",
    "account_type": "checking",
    "balance": "balance",
    "currency": "currency",
    "environment": "environment",
    "status": "active",
    "user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "admin_user_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "created_at": "2019-12-27T18:11:19.117Z",
    "organization_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "updated_at": "2019-12-27T18:11:19.117Z",
    "user_role": "user_role"
  }
]