Skip to main content
GET
List Users

Authorizations

token
string
header
required

Path Parameters

installSid
string
required

Install Sid

Pattern: ^AI[a-f0-9]{32}$

Query Parameters

admin
boolean

Filter admin user

offset
integer

Result offset

Required range: x >= 0
limit
integer

Number of items to return

Required range: x >= 0
sortKeys
enum<string>[]

Keys to sort the data

Available options:
createdDate,
lastName,
firstName
sortOrder
enum<string>
default:ASC

Order of sorting

Available options:
ASC,
DESC
firstName
string

First Name

lastName
string

Last Name

email
string

Email

sisId
string

SIS Id

lmsId
string

LMS Id

apiId
string

API Id

externalId
string

External Id

Response

200 - application/json

Successful

total
number

Total number of results

first
string | null

URL for first page

next
string | null

URL for next page

prev
string | null

URL for previous page

last
string | null

URL for last page

count
number

Number of results in this page

offset
number

Current offset

results
object[]

User records