Skip to main content
GET
/
users
Returns all users.
curl --request GET \
  --url https://api.smartermeasure.com/v3/users \
  --header 'Authorization: Basic <encoded-value>'
{
  "NumPages": "173",
  "Page": "1",
  "PageSize": "2",
  "Total": "345",
  "Start": "1",
  "End": "2",
  "FirstPageUri": "/v3/users?PageSize=2&PAGE=1",
  "LastPageUri": "/v3/users?PageSize=2&PAGE=173",
  "PreviousPageUri": "",
  "NextPageUri": "/v3/users?PageSize=2&PAGE=2",
  "User": [
    {
      "UserId": "10000001",
      "AssessmentKey": "sample-register-user",
      "AdministrativeGroupKey": "DACCD624-65C0-44E5-8515-E9EBA255B202",
      "FirstName": "Alice",
      "LastName": "Carter",
      "Email": "alice.carter@example.com",
      "InternalId": "STU-001",
      "AccessCode": "Xk9mPqRt",
      "HowManyCourses": [],
      "AgeRange": [],
      "Gender": [],
      "CompletionPercentage": "0",
      "DateTimeStarted": "2026-03-20T18:40:08Z",
      "DateTimeLastUpdated": [],
      "DateTimeCompleted": [],
      "Uri": "/users/10000001"
    },
    {
      "UserId": "10000002",
      "AssessmentKey": "sample-register-user",
      "AdministrativeGroupKey": "DACCD624-65C0-44E5-8515-E9EBA255B202",
      "FirstName": "Marcus",
      "LastName": "Webb",
      "Email": "marcus.webb@example.com",
      "InternalId": "STU-002",
      "AccessCode": "Tz4wNbVc",
      "HowManyCourses": [],
      "AgeRange": [],
      "Gender": [],
      "CompletionPercentage": "0",
      "DateTimeStarted": "2026-03-20T18:16:33Z",
      "DateTimeLastUpdated": [],
      "DateTimeCompleted": [],
      "Uri": "/users/10000002"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication with username and password

Query Parameters

​
UserID
string

Only show users with this UserID.

​
InternalID
string

Only show users with this InternalID.

​
Email
string

Only show users with this email address.

​
FirstName
string

Only show users with this first name.

​
LastName
string

Only show users with this last name.

​
AccessCode
string

Only show users with this access code.

​
OrderBy
string

How the results should be ordered.

​
ExcludeCustomQuestions
boolean
default:true

Exclude custom questions from results.

​
limit
integer
default:50

Limit number of records returned.

Required range: x <= 1000
​
offset
integer
default:1

Offset of the first row.

​
AssessmentKey
string

Comma delimited list of AssessmentKeys.

​
AdministrativeGroupKey
string

Comma delimited list of AdministrativeGroupKeys.

Response

200 - application/json

A list of users.

​
NumPages
string

Total number of pages.

​
Page
string

Current page number.

​
PageSize
string

Number of records per page.

​
Total
string

Total number of records.

​
Start
string

Start record index for the current page.

​
End
string

End record index for the current page.

​
FirstPageUri
string
​
LastPageUri
string
​
PreviousPageUri
string

Empty string if on first page.

​
NextPageUri
string

Empty string if on last page.

​
User
object

One or more user records. Returns an object when there is a single result, or an array when there are multiple results.