# Retrieve Counterparties

Retrieves a list of counterparties given the filter parameters provided

Endpoint: GET /v1/counterparties
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)
    Customer ID to whom the counterparty belongs

## 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.

  - `x-l2f-idempotency-id` (string)
    Unique ID used to safely retry an operation. See idempotency section for more details.

## Response 200 fields (application/json):

  - `data` (object, required)

  - `data.counterparties` (array, required)
    Counterparty List

  - `data.counterparties.id` (string)
    Unique Identifier for the counter party

  - `data.counterparties.customer_id` (string, required)
    The customer to which this counter party will be registered for use.

  - `data.counterparties.description` (string)
    Description of the counterparty.

  - `data.counterparties.counterparty_type` (string, required)
    The type of counterparty will determine the available rails for sending or receiving funds. See the guides for more detailed explanation of counterparty types.
    Enum: "FIAT_US", "FIAT_US_LINKED", "FIAT_CA", "FIAT_CA_LINKED", "CRYPTO"

  - `data.counterparties.status` (string, required)
    Counterparty status determines options available for use on the counterparty. 
* ACTIVE - Counterparty is open and available for use for withdrawal or deposits
* CLOSED - Counterparty is permanently closed, no further actions can be performed on the Counterparty. 
* PENDING - Counterparty is under additional review prior to moving to the OPEN or CLOSED state. No actions can be performed on the Counterparty in this state  
* FROZEN - Counterparty has been temporarily locked for all actions. 
* EDD -  Counterparty requires enhanced due diligence to be performed. The counterparty will operate as if active but may transition to FROZEN or CLOSED post due-diligence. 
* DORMANT - No activity has been seen in the last 12 months. The counterparty is 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