GET /candidates
Lists active public candidates for one sub-fest.
GET /public-api/v1/candidatesQuery Parameters
| Name | Type | Required | Notes |
|---|---|---|---|
subFestId | UUID | Yes | Sub-fest to list candidates from. |
page | integer | No | Defaults to 1. |
limit | integer | No | Defaults to 20, maximum 500. |
sortBy | string | No | Candidate sort field. |
sortOrder | asc or desc | No | Sort direction. |
search | string array | No | Text search terms. |
categoryIds | UUID array | No | Filter by categories. |
teamIds | UUID array | No | Filter by teams. |
gender | enum array | No | Filter by gender. |
isActive | boolean array | No | Public output is restricted to active candidates. |
chestNoPattern | string array | No | Filter by chest number. |
admNoPattern | string array | No | Filter by admission number. |
hasAvatar | boolean array | No | Filter by avatar presence. |
hasRegistration | boolean array | No | Filter by registration presence. |
sectionIds | UUID array | No | Filter by sections. |
Example
curl \
-H "X-API-Key: fst_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
"https://testapi.festie.app/public-api/v1/candidates?subFestId=00000000-0000-4000-8000-000000000000&hasRegistration=true"
Response Data
Each item includes public candidate identity, avatarUrl, subFest, category, team, sections, points summary, and registrationCount.
Private candidate fields such as email, phone, date of birth, and private admission details are not returned.
Last updated on