Skip to main content
GET
Get enrollments for a user

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

userId
string
required

The unique identifier for the user

Query Parameters

includeInactive
enum<string>
default:false

Include historical/tobedeleted enrollments. Defaults to false.

Available options:
true,
false
purpose
enum<string>

Filter by enrollment purpose. By default (or with purpose=academic), only legacy purpose-absent and explicit academic enrollments are returned; purpose=ncaa and purpose=enrichment return only their exact lane; purpose=all returns every lane and is intended for guardrail reads that must see the full enrollment set.

Available options:
academic,
ncaa,
enrichment,
all

Response

200 - application/json

Successful response

data
object[]
required
meta
object