Endpoint
What you must send
Every request must include a valid API client key: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 theAuthorization header:
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:- Authenticates the API client key.
- Verifies the key has the
people:readscope. - If
eventIdis missing, finds the current open event and limits results to it. - Applies optional filters:
query,gender,status,createdBy,idGt, andidLt. - Sorts by newest person first.
- Applies pagination using
idGt,idLt, andlimit.
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
Returns200 OK with an array of people.
If no people match the filters, the API returns an empty array:
Response fields
Errors
Pagination
For simple pagination, uselimit and idLt.
idLt with the last id returned from the
previous page because results are ordered from newest to oldest.