> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bridge.linkio.world/llms.txt
> Use this file to discover all available pages before exploring further.

# List customers

> Get your customers, one page at a time, newest first.

Requires the **Customers** scope (read).

## Headers

**API-Version** `string` *required* (default: 2026-10-29-atlas)

Your account's API version.

## Query

**page** `integer` (default: 1)

Which page to get. Starts at 1.

**limit** `integer` (default: 25)

How many per page. Up to 100.

## Response

`200 OK`

**status** `string`

`success`

**message** `string`

`Customers retrieved`

**count** `integer`

How many customers are on this page.

**pagination** `object`

**fields**

**page** `integer`

This page.

**limit** `integer`

Page size.

**total** `integer`

Total customers.

**total\_pages** `integer`

Total pages.

**has\_more** `boolean`

`true` if there's another page.

**customers** `array`

The customers. Each has the same fields as [Add a customer](https://docs.bridge.linkio.world/api-reference/customers/onboard.md#response).

## Errors

| Status | Code | Why |
| - | - | - |
| `422` | `validation_failed` | `page` is below 1, or `limit` is above 100. |

```bash cURL theme={null}
curl "https://sandbox.core.linkio.world/api/customers/list?page=1&limit=25" \
  -H "X-BRIDGE-API-Key: $BRIDGE_API_KEY" \
  -H "API-Version: 2026-10-29-atlas"
```

```json 200 theme={null}
{
  "status": "success",
  "message": "Customers retrieved",
  "count": 1,
  "pagination": { "page": 1, "limit": 25, "total": 1, "total_pages": 1, "has_more": false },
  "customers": [
    {
      "id": "cus_4hT9pL2mQx8VnR3tY7wZ1cB5dE",
      "type": "retail",
      "name": "Ada Obi",
      "email": "ada@example.com",
      "phone": "+2348012345678",
      "address": null,
      "country": null,
      "metadata": {}
    }
  ]
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.