/users

Returns the profile and other aggregate information for a single or multiple users, ordered by Username.

Optional Parameters:

Parameter

Description

Type

page

The specific page number in a paginated list of results

Including this parameter in your call will limit the response to a single page matching the page sequence order represented by the page number. 

INT

pageSize

The number of items to include in the page of results 

Including this parameter in your call will adjust the response to only include no more than the number of items that you specify on each page.

Note: The value “100” will be used by default if the parameter is not explicitly set and the maximum value is “500”. 

INT

userId

The user ID of the specific user whose profile will be returned in the response 

INT

username

The username of the specific user whose profile will be returned in the response 

STRING

cardId

The campus card ID of the specific user whose profile will be returned in the response 

STRING

sisId

The SIS ID of the specific user whose profile will be returned in the response 

STRING

affiliation

The affiliation value any user must have in order to have a profile returned in the response 

Note: Affiliation values are custom values set by each institution. Log in to your system and check the User Administration area to see examples of your affiliation values. 

STRING

enrollmentStatus

The enrollment status value any user must have in order to have a profile returned in the response 

Note: Enrollment status values are custom values set by each institution. Log in to your system and check the User Administration area to see examples of your enrollment status values.

STRING

SchoolOfEnrollment

The primary school of enrollment value any user must have in order to have a profile returned in the response

Note: Primary school of enrollment values are custom values set by each institution. Log in to your system and check the User Administration area to see examples of your primary school of enrollment values.

STRING

status

The account status value any user must have in order to have a profile returned in the response 

Including this parameter in your call will limit the response to only include users with the account status value specified.

Note: Accepted values include “active” (includes only confirmed users), “archived” (includes confirmed and unconfirmed users), or “all” (includes confirmed and unconfirmed users). The value “active” will be used by default if the parameter is not explicitly set. 

STRING

CreatedOnStart

A date filter based on the date that the user created 

Including this parameter in your call will limit the response to only include users that have been created since the date included in your call.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

 LONG

CreatedOnEnd

 A date filter based on the date that the user created 

Including this parameter in your call will limit the response to only include users that have been created before the date included in your call.

Note: dates must be represented in milliseconds/UTC time (e.g., November 12, 2013 is 1384232400000 milliseconds since 1/1/1970 00:00:00 which is the start of Unix Epoch Time)

 LONG


Example: Calling for a specific user

Sample Call:

https://yoursite/api/users/99062 (shown below) or https://yoursite/api/users?userId=99062 (response structure same as calls for multiple or all user

Sample Response:

 

Example: Calling for all users in the system

Sample Call:

https://yoursite/api/users

Sample Response:

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Contact Us