Skip to main content
GET
/
v1
/
installs
/
{installSid}
/
users
List Users
curl --request GET \
  --url http://api.dev.smarterproctoring.com/v1/installs/{installSid}/users \
  --header 'token: <api-key>'
{
  "total": 123,
  "first": "<string>",
  "next": "<string>",
  "prev": "<string>",
  "last": "<string>",
  "count": 123,
  "offset": 123,
  "results": [
    {
      "sid": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>",
      "username": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.smarterservices.com/llms.txt

Use this file to discover all available pages before exploring further.

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