Skip to main content
GET
/
ims
/
oneroster
/
rostering
/
v1p2
/
enrollments
Get all Enrollments
curl --request GET \
  --url https://api.alpha-1edtech.ai/ims/oneroster/rostering/v1p2/enrollments/ \
  --header 'Authorization: Bearer <token>'
{
  "enrollments": [
    {
      "sourcedId": "<string>",
      "status": "active",
      "role": "administrator",
      "primary": "false",
      "beginDate": "2024-01-01",
      "endDate": "2024-01-01",
      "user": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "class": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "school": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "course": {
        "href": "<string>",
        "sourcedId": "<string>",
        "type": "<string>",
        "name": "<string>"
      },
      "dateLastModified": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "totalCount": 123,
  "pageCount": 123,
  "pageNumber": 123,
  "offset": 123,
  "limit": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
fields
string

Comma-separated list of fields to include in the response

Example:

"sourcedId,name"

​
limit
integer
default:100

The maximum number of items to return in the paginated response. While the OneRoster specification does not define a maximum limit, this implementation enforces a maximum of 3000 to prevent abuse and ensure optimal performance.

Required range: 1 <= x <= 3000
Example:

100

​
offset
integer
default:0

The number of items to skip in the paginated response

Required range: x >= 0
Example:

0

​
sort
string

The field to sort the response by

​
orderBy
enum<string>

The order to sort the response by

Available options:
asc,
desc
​
filter
string

The filter to apply to the response

Example:

"status='active'"

​
search
string

PROPRIETARY EXTENSION: Free-text search across multiple fields. Provides convenient text-based querying beyond the standard OneRoster filter parameter.

Example:

"john"

Response

Successful response

​
enrollments
object[]
required
​
totalCount
number
required
​
pageCount
number
required
​
pageNumber
number
required
​
offset
number
required
​
limit
number
required