# Retrieve Customers

Retrieve customers matching the provided query parameters

Endpoint: GET /v1/customers
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)

  - `type` (string)
    Type of Customer
    Enum: "INDIVIDUAL", "CORPORATION"

  - `status` (string)
    * ACTIVE - Customer is active and available for use in line with client configuration. 
* CLOSED -  Customer is permanently closed, no further actions can be performed on it or associated accounts. 
* PENDING -  Customer is under additional review. No actions can be performed on the account.   
* FROZEN - Customer and associated accounts have been temporarily locked for all actions. 
* EDD -  Customer requires enhanced due diligence to be performed. The customer and accounts will operate as if frozen. 
* DORMANT - No activity has been seen in the last 12 months. Customer and accounts are available for use.
    Enum: "ACTIVE", "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.customers` (array, required)
    Customer List

  - `data.customers.id` (string, required)
    Unique Identifier for the customer

  - `data.customers.customer_type` (string, required)
    Type of customer
    Enum: "INDIVIDUAL", "CORPORATION"

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

  - `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