SMsmarterproctoring
User

List Users

Returns a paginated list of users for the specified install.

get/v1/installs/{installSid}/users

Request

  • Base URL
    https://api.smarterproctoring.com
  • URL
    https://api.smarterproctoring.com/v1/installs/{installSid}/users
  • Auth
    API key in header token

Path parameters

installSidstring required

Install Sid

Query parameters

adminboolean

Filter admin user

offsetinteger

Result offset

limitinteger

Number of items to return

sortKeysstring[]

Keys to sort the data

sortOrder'ASC' | 'DESC'

Order of sorting

firstNamestring

First Name

lastNamestring

Last Name

emailstring

Email

sisIdstring

SIS Id

lmsIdstring

LMS Id

apiIdstring

API Id

externalIdstring

External Id

Response

Successful

totalnumber

Total number of results

firststring nullable

URL for first page

nextstring nullable

URL for next page

prevstring nullable

URL for previous page

laststring nullable

URL for last page

countnumber

Number of results in this page

offsetnumber

Current offset

Changes

No recorded changes to this operation across all 13 revisions of this API.