Skip to main content

Field selection

The fields query parameter controls which top-level groups appear in each application object. id is always included.

Groups​

GroupContents
personalApplicant identity from the submission profile (name, email, phone, DOB, gender, nationality, education level, last school, location).
applicationProgram/cycle/campus ids + resolved names, admission stage, decision, decision_sent, enrolled, and timestamps.
paymentpaid flag and amount.
answersRaw questionnaire responses keyed by question id. File uploads become signed download URLs.

Presets​

fields valueExpands to
default (or omitted)personal, application, payment
allpersonal, application, payment, answers

Custom selection​

Pass a comma-separated list of group names (or aliases):

?fields=personal,application
?fields=application,answers

Aliases: profile→personal, status/meta→application, payments→payment, responses/documents/docs→answers. Unknown tokens are ignored; if nothing valid is requested, the default preset is used.

Example​

# Just the decision-relevant metadata, no PII payload
curl -s "https://api.uapply.africa/api/v1/applications?fields=application" \
-H "Authorization: Bearer $UAPI_KEY"
{
"id": "9f2…",
"application": {
"program_name": "BSc Engineering",
"cycle_name": "2026 Intake",
"stage": "submitted",
"decision": "none",
"enrolled": false,
"submitted_at": "2026-05-20T09:12:00.000Z"
}
}