Skip to Content
Welcome to Festie! 🎪 The ultimate festival management platform is here!
Public REST APIGET /candidates

GET /candidates

Lists active public candidates for one sub-fest.

GET /public-api/v1/candidates

Query Parameters

NameTypeRequiredNotes
subFestIdUUIDYesSub-fest to list candidates from.
pageintegerNoDefaults to 1.
limitintegerNoDefaults to 20, maximum 500.
sortBystringNoCandidate sort field.
sortOrderasc or descNoSort direction.
searchstring arrayNoText search terms.
categoryIdsUUID arrayNoFilter by categories.
teamIdsUUID arrayNoFilter by teams.
genderenum arrayNoFilter by gender.
isActiveboolean arrayNoPublic output is restricted to active candidates.
chestNoPatternstring arrayNoFilter by chest number.
admNoPatternstring arrayNoFilter by admission number.
hasAvatarboolean arrayNoFilter by avatar presence.
hasRegistrationboolean arrayNoFilter by registration presence.
sectionIdsUUID arrayNoFilter 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