Skip to main content
GET
Get Parents

Authorizations

Authorization
string
header
required

Bearer access token from POST /oauth/token (OAuth 2.0 client credentials; the OneRoster /ims/oneroster/v1p1/token and /v1p2/token URLs are aliases). Send it as Authorization: Bearer <access_token>. Tokens expire after 1 hour and carry your API client's granted scopes — an endpoint outside them returns 403.

Query Parameters

limit
integer<int32>
default:100

To define the download segmentation value i.e. the maximum number of records to be contained in the response.

Required range: x >= 1
offset
integer<int32>
default:0

The number of the first record to be supplied in the segmented response message.

Required range: x >= 0
sort
string

Identifies the sort criteria to be used for the records in the response message. Use with the orderBy parameter.

orderBy
enum<string>
default:asc

The form of ordering for response to the sorted request i.e. ascending (asc) or descending (desc).

Available options:
asc,
desc
filter
string

The filtering rules to be applied when identifying the records to be supplied in the response message.

fields
string[]

To identify the range of fields that should be supplied in the response message.

Response

200 - application/json

OK

users
object[]
required