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

# List Customers

> Retrieve a paginated list of all customers in your account

Returns all customers associated with your account, with support for filtering and pagination.

```
GET https://api.yativo.com/api/v1/customer
```

## Query parameters

<ParamField query="per_page" type="integer">
  Number of records per page (default: 20).
</ParamField>

<ParamField query="email" type="string">
  Filter by email (partial match).
</ParamField>

<ParamField query="country" type="string">
  Filter by ISO 3166-1 alpha-3 country code (e.g. `"USA"`, `"BRA"`).
</ParamField>

<ParamField query="kyc_status" type="string">
  Filter by KYC status.
</ParamField>

<ParamField query="is_kyc_approved" type="boolean">
  Filter by KYC approval status. Pass `"true"` or `"false"`.
</ParamField>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET 'https://api.yativo.com/api/v1/customer?per_page=20' \
    -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://api.yativo.com/api/v1/customer?per_page=20', {
    headers: { 'Authorization': `Bearer ${token}` },
  });
  const data = await response.json();
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
    "status": "success",
    "data": [
      {
        "id": 1,
        "customer_id": "c586066b-0f29-468f-b775-15483871a202",
        "customer_name": "Alex Smith",
        "customer_email": "alex.smith@example.com",
        "customer_phone": "+15551234567",
        "customer_country": "USA",
        "customer_type": "individual",
        "customer_status": "active",
        "created_at": "2026-04-02T10:00:00.000000Z",
        "updated_at": "2026-04-02T10:00:00.000000Z"
      },
      {
        "id": 2,
        "customer_id": "d47f8a2b-1c3e-4f5a-9b8c-7d6e5f4a3b2c",
        "customer_name": "Acme Corporation LLC",
        "customer_email": "compliance@acme.com",
        "customer_phone": "+13055559876",
        "customer_country": "USA",
        "customer_type": "business",
        "customer_status": "active",
        "created_at": "2026-03-15T08:30:00.000000Z",
        "updated_at": "2026-03-15T08:30:00.000000Z"
      }
    ],
    "pagination": {
      "total": 42,
      "per_page": 20,
      "current_page": 1,
      "last_page": 3,
      "next_page_url": "https://api.yativo.com/api/v1/customer?page=2",
      "prev_page_url": null
    }
  }
  ```
</ResponseExample>