GET/hyax-api/v1/people

Authentication

Send `Authorization: Bearer hx_your_key` on all `/hyax-api/v1/*` routes unless documented as public. Keys use the `hx_` prefix and are SHA-256 hashed server-side. This example is a minimal authenticated GET to verify your key works.

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

Query parameters

Name	Required	Description
limit	No	Set `limit=1` to test auth.

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=1' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example response

Shape varies by data; values are illustrative.

{
  "success": true,
  "data": [],
  "pagination": { "total": 0, "limit": 1, "offset": 0, "hasMore": false }
}