---
title: "Get Customers"
method: GET
path: "/v1/customers"
tags: ["Customers"]
---

# Get Customers

`GET /v1/customers`

Retrieve a list of customers with optional filtering and pagination.

## Query parameters

- `customerStatus` 'ONBOARDING' | 'ACTIVE' | 'INACTIVE' | 'ONBOARDING_FAILED'
- `createDateStart` string, date-time
- `createDateEnd` string, date-time
- `referenceId` string
- `after` string
- `limit` string, integer
- `sortField` 'customerStatus' | 'createdDate' | 'referenceId'
- `sortDirection` 'ASC' | 'DESC'

## Response `200`

OK

- object
  - `after` string, nullable — The token of the last item in the response
  - `totalCount` string, integer — The total number of items in the entire filtered data set
  - `items` object[]
    - `customerId` string, uuid
    - `referenceId` string
    - `customerStatus` 'ONBOARDING' | 'ACTIVE' | 'INACTIVE' | 'ONBOARDING_FAILED'
    - `customerType` 'RETAIL' | 'ENTERPRISE' | 'WEALTH'
    - `onboardingStatus` 'PENDING_DOCUMENTATION_RECEIPT' | 'PROCESSING' | 'FAILED' | 'UNDER_REVIEW' | 'ONBOARDED' | 'OFFBOARDED'
    - `createDate` string, date-time
    - `customerPreTradeRiskGroup` 'LOW' | 'HIGH'
    - `accounts` object[] — Account information about a customer
      - `accountNumber` string
      - `accountName` string, nullable
      - `accountId` string, uuid
      - `accountStatus` 'ACTIVE' | 'INACTIVE' | 'CREATING'
      - `accountType` 'CREDIT' | 'CASH'

## Other responses

- `401` — Unauthorized
- `404` — Not Found

---

[API](https://skmtc.net/aquanow/apis/aquanow-cams-rest-api.md) · [All operations](https://skmtc.net/aquanow/apis/aquanow-cams-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aquanow/aquanow-cams-rest-api/revisions/c62a02b27407/schema)