> For the complete documentation index, see [llms.txt](https://docs.ezeebit.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ezeebit.com/customer-accounts/list-customer-accounts.md).

# List Customer Accounts

Page through your customer accounts, with optional search and status filters.

**Live:**

<mark style="color:green;">`POST`</mark> [<mark style="color:blue;">https://api.ezeebit.com/open/api/v1/customerAccount/list</mark>](https://api.ezeebit.com/open/api/v1/customerAccount/list)

**UAT:**

<mark style="color:green;">`POST`</mark> [<mark style="color:blue;">https://uat-api.ezeebit.com/open/api/v1/customerAccount/list</mark>](https://uat-api.ezeebit.com/open/api/v1/customerAccount/list)

## Headers

| Name                   | Type   | Required | Value                          |
| ---------------------- | ------ | -------- | ------------------------------ |
| Content-Type           | string | Y        | application/json               |
| Ezeebit-Timestamp      | long   | Y        | Unix timestamp in milliseconds |
| Ezeebit-Nonce          | string | Y        | 32 characters                  |
| Ezeebit-Certificate-SN | string | Y        | API key issued by Ezeebit Pay  |
| Ezeebit-Signature      | string | Y        | Uppercase SHA512 signature     |

## Request Body

```json
{
  "pageIndex": 1,
  "pageSize": 20,
  "search": "cust-10",
  "status": "ACTIVE"
}
```

## Form data

| Parameter | Type   | Required | Description                                                                                          |
| --------- | ------ | -------- | ---------------------------------------------------------------------------------------------------- |
| pageIndex | int    | No       | Page number. Default `1`.                                                                            |
| pageSize  | int    | No       | Rows per page. `1`–`100`. Default `20`.                                                              |
| search    | string | No       | Partial, case-insensitive match on `customerAccountId` or `accountName`, at most **128 characters**. |
| status    | string | No       | `ACTIVE` or `FROZEN`. Omit it for both.                                                              |

Send `{}` for the first page of every account. Newest accounts come first. Each row carries the account's USDT balance; for its deposit addresses, call [Customer Account Details](https://docs.ezeebit.com/customer-accounts/customer-account-details.md).

## Response

| Status | Description                                                     |
| ------ | --------------------------------------------------------------- |
| 200    | Accounts returned                                               |
| 400    | Invalid `status`, `pageSize` or `search`. `msg` names the field |

{% tabs %}
{% tab title="200" %}

```json
{
  "code": 200,
  "msg": "success",
  "data": {
    "totalCount": 2,
    "totalPage": 1,
    "pageSize": 20,
    "currentPageNo": 1,
    "data": [
      {
        "customerAccountId": "cust-1002",
        "accountName": "Customer 1002",
        "status": "ACTIVE",
        "unit": "USDT",
        "balance": "0.00000000"
      },
      {
        "customerAccountId": "cust-1001",
        "accountName": "Customer 1001",
        "status": "ACTIVE",
        "unit": "USDT",
        "balance": "250.00000000"
      }
    ]
  }
}
```

{% endtab %}
{% endtabs %}
