Pagination

By default, a total of 50 records starting with the first record is returned per request. Pagination query parameters can be used to page through a list of records. The following pagination parameters are supported:

Parameter

Default

Description

startIndex

1

A 1-based index that specifies the index of the first record returned. Any value less than 1 will be interpreted as 1.

This value is distinct from the user ID. User records are ordered by user ID, and startIndex represents the index or position of the user record in the list of all records returned.

count

50

An integer than specifies the total number of records returned per page. The maximum number of records that can be returned is 100.

For example, if your organization has 50 users, and you would like to list all users across 2 pages:

A request to GET /Users/?startIndex=1&count=25 would return 25 users starting with the 1st user. This represents the first page of your total users.
A request to GET /Users/?startIndex=26&count=25 would return 25 users starting with the 26th user. This represents the second page of your total users.

The following pagination attributes are returned in the response body:

Parameter	Description
`itemsPerPage`	An integer that represents the number of records returned per page.
`startIndex`	A 1-based index that represents the index of the first record returned.
`totalResults`	An integer that represents the total number of records that match the query.

Filtering Users

This endpoint supports filtering users by email (userName).

Filter query params must follow the format:
filter=userName eq "example@informedk12.com".
eq is the only filter operator supported.
userName is the only filter attribute supported.

200Success

400Bad Request

401Unauthorized

403Forbidden