Skip to main content

List customers

Method GET​

https://my.easyweek.io/api/public/v2/customers

Description: This endpoint returns the customers of the workspace, paginated. It can also be used to look a single customer up by exact phone or email — pass the phone or email query parameter and the response contains the matching customer (or an empty list). Customers are workspace-global; they are not tied to a location.

Example Request​

curl -i -X GET \
  https://my.easyweek.io/api/public/v2/customers?phone={phone}&email={email}&per_page={per_page} \
  -H 'Authorization: Bearer <YOUR_SECRET>' \
  -H 'Workspace: <YOUR_WORKSPACE>'

Query Parameters​

  • phone (string, optional): Exact-match lookup by phone number. The value is normalized to E.164 using the workspace country before matching, so +12025550111 and 2025550111 resolve to the same customer.
  • email (string, optional): Exact-match lookup by email address (case-insensitive).
  • per_page (integer, optional): Number of items per page (alias of limit), maximum 100. Defaults to 15.

Example Response​

{
  "data": [
    {
      "uuid": "b6d6a1f2-6f1e-4a2b-9a2c-1f2e3d4c5b6a",
      "first_name": "Jane",
      "last_name": "Doe",
      "middle_name": null,
      "phone": "+12025550111",
      "email": "jane@example.com"
    }
  ],
  "links": {
    "first": "https://my.easyweek.io/api/public/v2/customers?page=1",
    "last": "https://my.easyweek.io/api/public/v2/customers?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://my.easyweek.io/api/public/v2/customers",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}