Sign in

v2

latestOpenAPI 3.0.02026-07-2163203194.5 KB
User

List Users

Returns a paginated list of users for the specified install.

get/v1/installs/{installSid}/users

Path parameters

installSidstring required

Install Sid

Install Sid

Query parameters

adminboolean

Filter admin user

Filter admin user

offsetinteger

Result offset

Result offset

limitinteger

Number of items to return

Number of items to return

sortKeysstring[]

Keys to sort the data

Keys to sort the data

sortOrder'ASC' | 'DESC'

Order of sorting

Order of sorting

firstNamestring

First Name

First Name

lastNamestring

Last Name

Last Name

emailstring

Email

Email

sisIdstring

SIS Id

SIS Id

lmsIdstring

LMS Id

LMS Id

apiIdstring

API Id

API Id

externalIdstring

External Id

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