# Retrieve Accounts

Retrieves a list of accounts given the filter parameters provided

Endpoint: GET /v1/accounts/deposits
Version: 1.1.2
Security: OAuth2Flow

## Query parameters:

  - `page` (integer)
    Page of records to get (default 0 = first page)

  - `page_size` (integer)
    Records to return per page (default = 20)

  - `customer_id` (string)
    Account holder customer ID

  - `product_type` (string)
    * CLIENT - Accounts at the Client level for managing client treasury operations
* DEPOSIT - Accounts at the Customer level account for managing customer funds on platform
* VIRTUAL - Accounts at the Customer level account for tracking externally managed customer funds 

see account concepts for more details.
    Enum: "CLIENT", "DEPOSIT", "VIRTUAL"

  - `status` (string)
    * OPEN - Account is open and available for use in line with its product configuration
* CLOSED - Account is permanently closed, no further actions can be performed on the account.  
* PENDING - Account is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the account.  
* FROZEN - Account has been temporarily locked for all actions (deposits, transfers, exchanges and withdrawals).  
* EDD -  Account (and/or customer) requires enhanced due diligence to be performed. The accounts will operate as if frozen. 
* DORMANT - No activity has been seen in the last 12 months. The account is available for use.
    Enum: "OPEN", "CLOSED", "FROZEN", "PENDING", "EDD", "DORMANT"

## Header parameters:

  - `Authorization` (string)
    OAuth bearer token (see authentication flows)

  - `x-l2f-request-id` (string)
    Optional Unique ID per request, useful for fault resolution/diagnosis and audit.

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.accounts` (array, required)
    Account List

  - `data.accounts.id` (string, required)
    Unique Identifier for the account - defined by the Client during account open

  - `data.accounts.status` (string, required)
    Account Status - will determine servicing options on the account. 
* OPEN - Account is open and available for use in line with its product configuration
* CLOSED - Account is permanently closed, no further actions can be performed on the account.  
* PENDING - Account is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the account.  
* FROZEN - Account has been temporarily locked for all actions (deposits, transfers, exchanges and withdrawals).  
* EDD -  Account (and/or customer) requires enhanced due diligence to be performed. The accounts will operate as if frozen. 
* DORMANT - No activity has been seen in the last 12 months. The account is available for use.
    Enum: "OPEN", "CLOSED", "FROZEN", "PENDING", "EDD", "DORMANT"

  - `data.accounts.asset_type_id` (string, required)
    Asset type IDs follow a simple structure as follows: {$BLOCKCHAIN}_{$NETWORK}_{$CURRENCY_CODE}  Simple asset type to test with include 
- ETHEREUM_SEPOLIA_ETH
- ETHEREUM_SEPOLIA_USDC
- SOLANA_DEVNET_SOL
- BITCOIN_TESTNET_BTC
- FIAT_TESTNET_USD
- FIAT_TESTNET_USD
- FIAT_MAINNET_USD
- FIAT_TESTNET_EUR

  - `data.accounts.product_type` (string, required)
    * CLIENT - Accounts at the Client level for managing client treasury operations
* DEPOSIT - Accounts at the Customer level account for managing customer funds on platform
* VIRTUAL - Accounts at the Customer level account for tracking externally managed customer funds 

See [account concepts](#section/Concepts/Accounts) for additional details on these product types
    Enum: "CLIENT", "DEPOSIT", "VIRTUAL"

  - `data.accounts.product_id` (string, required)
    Client Product configuration this account respects. These are configured in the management portal. Default products include BASIC_DEPOSIT

  - `data.accounts.customer_id` (string, required)
    Customer ID for whom the account belongs to

  - `data.accounts.current_balance` (number, required)
    Full balance on the account including funds on hold

  - `data.accounts.available_balance` (number, required)
    Balance available for immediate spending (excludes held funds)

  - `links` (object, required)
    See the [pagination](https://docs.layer2financial.com/guides/pagination/) section for additional details on the generic pagination approach.

  - `links.self` (string, required)
    endpoint to the current page of results

  - `links.first` (string, required)
    endpoint to the first page of results

  - `links.prev` (string, required)
    endpoint to the previous page of results

  - `links.next` (string, required)
    endpoint to the next page of results

  - `links.last` (string, required)
    endpoint to the last page of results

## Response 400 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description

## Response 401 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description

## Response 404 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description

## Response 500 fields (application/json):

  - `errors` (array)
    Error List

  - `errors.code` (string)
    Layer2 Standard Error Code

  - `errors.description` (string)
    Error Description