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

# List customers

Retrieves a paginated list of customers for your organisation. Results are sorted by `created_at` in descending order.

**GET /public/customers**

#### **Authorizations**

**Authorization**

**string**

**header**

**required**

Bearer authentication header of the form `Bearer <token>`, where `<token>` is your REST API token.

#### **Query Parameters**

**email**

**string**

Filter results to the customer matching the provided email address.

Example:

`"jane.smith@example.com"`

**platform**

**enum\<string>**

Filter results to customers from the specified platform.

Available options:

`shopify`,

`woocommerce`

**per\_page**

**integer**

**default: 20**

The number of results per page.

Required range: `1 <= x <= 100`

**page**

**integer**

**default: 1**

The page number to retrieve.

#### **Response**

**200 - application/json**

**data**

**object\[]**

Hide child attributes

**data.id**

**string\<uuid>**

Unique UUID identifier for the customer in Yuko.

Example:

`"63a2c89a-9936-4bc0-9d5f-93db46110b76"`

**data.first\_name**

**string | null**

Example:

`"Jane"`

**data.last\_name**

**string | null**

Example:

`"Smith"`

**data.email**

**string**

Example:

`"jane.smith@example.com"`

**data.phone**

**string | null**

Example:

`"+14155552671"`

**data.platform**

**string**

The ecommerce platform the customer was synced from.

Example:

`"shopify"`

**data.platform\_customer\_id**

**string | null**

Example:

`"7823491023"`

**data.points**

**object**

Hide child attributes

**data.points.balance**

**integer**

Current redeemable points balance.

Example:

`350`

**data.points.earned**

**integer**

Total points ever earned.

Example:

`500`

**data.points.redeemed**

**integer**

Total points redeemed.

Example:

`150`

**data.created\_at**

**string\<date-time>**

Example:

`"2024-06-01T10:00:00.000Z"`

**data.updated\_at**

**string\<date-time>**

Example:

`"2026-02-15T08:30:00.000Z"`

**meta**

**object**

Hide child attributes

**meta.pagination**

**object**

Hide child attributes

**meta.pagination.current\_page**

**integer**

Example:

`1`

**meta.pagination.per\_page**

**integer**

Example:

`20`

**meta.pagination.total**

**integer**

Example:

`120`

**meta.pagination.last\_page**

**integer**

Example:

`6`

**meta.pagination.has\_more**

**boolean**

Example:

`true`

<RequestExample>
  ```bash cURL theme={null}
  curl --request GET \
    --url "https://api.yukoapp.com/api/v1/public/customers?per_page=20&page=1" \
    --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
  ```

  ```javascript JavaScript theme={null}
  const params = new URLSearchParams({ per_page: 20, page: 1 });

  const response = await fetch(
    `https://api.yukoapp.com/api/v1/public/customers?${params}`,
    {
      method: "GET",
      headers: {
        Authorization: "Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      },
    }
  );

  const data = await response.json();
  ```

  ```php PHP theme={null}
  $query = http_build_query(["per_page" => 20, "page" => 1]);

  $ch = curl_init();
  curl_setopt($ch, CURLOPT_URL, "https://api.yukoapp.com/api/v1/public/customers?{$query}");
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  $data = json_decode($response, true);
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "id": "63a2c89a-9936-4bc0-9d5f-93db46110b76",
        "first_name": "Jane",
        "last_name": "Smith",
        "email": "jane.smith@example.com",
        "phone": "+14155552671",
        "platform": "shopify",
        "platform_customer_id": "7823491023",
        "points": {
          "balance": 350,
          "earned": 500,
          "redeemed": 150
        },
        "created_at": "2024-06-01T10:00:00.000Z",
        "updated_at": "2026-02-15T08:30:00.000Z"
      }
    ],
    "meta": {
      "pagination": {
        "current_page": 1,
        "per_page": 20,
        "total": 1,
        "last_page": 1,
        "has_more": false
      }
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": "invalid_token",
      "message": "Invalid or revoked API token"
    }
  }
  ```
</ResponseExample>