Skip to main content

Endpoint

What you must send

Every request must include a valid API client key:
The key must have the people:read scope. For a basic search, send at least one search parameter such as query, limit, or a filter. If you do not send eventId, Taeh searches inside the current open event automatically.

Authentication

Use an API client key in the Authorization header:
The API client key must include the people:read scope.
When an API client calls this endpoint without an eventId, results are automatically limited to the current open event.

Query parameters

Request logic

Taeh applies the request in this order:
  1. Authenticates the API client key.
  2. Verifies the key has the people:read scope.
  3. If eventId is missing, finds the current open event and limits results to it.
  4. Applies optional filters: query, gender, status, createdBy, idGt, and idLt.
  5. Sorts by newest person first.
  6. Applies pagination using idGt, idLt, and limit.
If no current event is open and you do not send eventId, the API returns 200 OK with an empty array.

cURL example

Example with filters

Success response

Returns 200 OK with an array of people. If no people match the filters, the API returns an empty array:
Each matching record has this shape:

Response fields

Errors

Pagination

For simple pagination, use limit and idLt.
For cursor-style pagination, use idLt with the last id returned from the previous page because results are ordered from newest to oldest.