GET/hyax-api/v1/people/by-email

Get person by email

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

Query parameters

Name	Required	Description
email	Yes	Email address (trimmed, lowercased)

Request examples

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

curl -X GET 'https://platform.hyax.com/hyax-api/v1/people/[email protected]' \
  -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",
    "avatarUrl": null,
    "category": "LEAD",
    "tags": [],
    "signupSource": "API",
    "phone": null,
    "address1": null,
    "address2": null,
    "city": null,
    "state": null,
    "zipCode": null,
    "country": null,
    "purchaseValue": 0,
    "metadata": null,
    "subscriberStatus": "ACTIVE",
    "subscribedAt": "2025-01-15T12:00:00.000Z",
    "unsubscribedAt": null,
    "createdAt": "2025-01-15T12:00:00.000Z",
    "updatedAt": "2025-01-15T12:00:00.000Z",
    "subscription": {
      "status": "ACTIVE",
      "subscribedAt": "2025-01-15T12:00:00.000Z",
      "unsubscribedAt": null
    }
  }
}