Skip to main content
POST
Get users eligible to enroll in an institution

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json
institution
string
required

Institution ID to find eligible users for

Pattern: ^[0-9a-fA-F]{24}$
Example:

"67826dfe5d387207aabd6fc1"

Optional search term to filter by name or email (2+ characters)

Example:

"john"

Response

Successfully retrieved eligible users

success
boolean
Example:

true

data
object[]

List of eligible users (max 100)

total
integer

Total number of eligible users before capping

Example:

42