Skip to main content
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 
curl --request GET \
  --url "https://api.yukoapp.com/api/v1/public/customers?per_page=20&page=1" \
  --header "Authorization: Bearer py_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

{
  "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
    }
  }
}