GET/hyax-api/v1/people

List people

Base URL: https://platform.hyax.com · Replace YOUR_API_KEY with your team API key.

Query parameters

Name	Required	Description
limit	No	Page size (default 25, max 100)
offset	No	Offset (default 0)
search	No	Filter by email or name (case-insensitive contains)
tag	No	Exact tag match (lowercased)
category	No	`LEAD` \| `CUSTOMER` \| `CANCELLED`

Request examples

Same request in cURL, Node.js (fetch), and PHP (ext-curl).

curl -X GET 'https://platform.hyax.com/hyax-api/v1/people?limit=10&offset=0' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [
    {
      "id": "clx…",
      "email": "[email protected]",
      "name": "Ada",
      "category": "LEAD",
      "tags": ["newsletter"],
      "signupSource": "API",
      "phone": null,
      "city": null,
      "state": null,
      "country": null,
      "purchaseValue": 0,
      "metadata": null,
      "createdAt": "2025-01-15T12:00:00.000Z",
      "updatedAt": "2025-01-15T12:00:00.000Z"
    }
  ],
  "pagination": { "total": 1, "limit": 25, "offset": 0, "hasMore": false }
}