One or more user records. Returns an object when there is a single result, or an array when there are multiple results.
object
object[]
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SmarterServices Platform","colors":{"primary":"#015692","light":"#0D9373","dark":"#015692"},"logo":{"light":"https://cdn.prod.website-files.com/650b016f7e13a7d9de337f22/6629053ca1393100c09aa484_SmarterServices%20Logo.png","dark":"https://cdn.prod.website-files.com/650b016f7e13a7d9de337f22/6629053ca1393100c09aa484_SmarterServices%20Logo.png"},"favicon":"https://mintcdn.com/smarterservicesllc/fCrC3qjG9fnKrDR3/favicon.png?fit=max\u0026auto=format\u0026n=fCrC3qjG9fnKrDR3\u0026q=85\u0026s=4ebd4e7b2756068bf227df06619633a6","api":{"openapi":["https://api.smarterproctoring.com/openapi.json","assessment/api/openapi.json"]},"navbar":{"links":[{"href":"https://intercom.help/smarterservices-llc-028a8a0949b6/en","label":"Support"}]},"footer":{"socials":{"website":"https://www.smarterservices.com","youtube":"https://www.youtube.com/@smarterservices","linkedin":"https://www.linkedin.com/company/smarterservices","facebook":"https://www.facebook.com/smarterservices","x":"https://x.com/smarterservices","github":"https://github.com/smarterservices"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smarterservicesllc","hasAudioNarration":false,"actualSubdomain":"smarterservicesllc","customDomains":["developers.smarterservices.com"],"gitSource":{"type":"github","owner":"smarterservices","repo":"platform-documenation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a5de60074e183eea51381f1","collectionId":"b4811552-fb4e-467d-88a2-623c3838f2d6","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a5de60074e183eea51381f1"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6a5de60074e183eea51381f1:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Proctoring","count":70},{"language":"default","tag":"Endpoints","count":63},{"language":"default","tag":"Platform","count":33},{"language":"default","tag":"BlockKit","count":25},{"language":"default","tag":"Reports","count":17},{"language":"default","tag":"Assessment","count":16},{"language":"default","tag":"API Reference","count":13},{"language":"default","tag":"SmarterElements","count":10},{"language":"default","tag":"Security \u0026 Authorization","count":9},{"language":"default","tag":"Getting Started","count":8}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".elements-example{border:1px solid #ddd;border-radius:var(--rounded-2xl, 1rem);overflow-y:auto;padding:5px}"}],"page":{"pagePath":"assessment/api/users/list-users","slug":"/assessment/api/users/list-users","pageMetadata":{"title":"List Users","description":"Get a list of users that match the specified criteria","openapi":"GET /users","href":"/assessment/api/users/list-users"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get a list of users that match the specified criteria\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"List Users","description":"Get a list of users that match the specified criteria","openapi":"GET /users","href":"/assessment/api/users/list-users"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Returns all users.","parameters":["2ed124dd-d999-4724-b921-6da35e5e921e","e1c38b56-005b-412d-945b-2c6c1e8af07e","fe18e17e-f293-4ddf-9abc-73ecd5525208","abfd9af9-5a30-40c0-876c-7d880f4bd0cf","f409bf5d-ee91-479e-83e0-90f0bd2e4fa5","58e7dad6-0fe1-4930-b873-b8a78281ca55","5a536f64-66da-45a0-837f-2178bb8a73fd","5bf9a26d-777e-436b-9659-cf1875c6146f","b149e57c-929e-46ee-a764-f53d8d3dbdf1","d1e4fe07-b7bc-4ffb-98b6-8cb814164639","59923c93-2d3f-4291-a7b6-90cefbea94c1","28d438fe-6ab9-4e10-bc2e-1736c6714ce4"],"responses":{"200":"e4f6d6ea-fe4d-49f5-a969-8ebda2297c64"},"method":"get","type":"path","servers":["b5743c61-bdb0-42c1-b80d-894970f966b6"],"security":["8a24586e-869e-48c7-aaa7-e78b0946525a"],"path":"/users","baseUrlOptions":["https://api.smartermeasure.com/v3"],"title":"Returns all users.","description":"Get a list of users that match the specified criteria","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"2ed124dd-d999-4724-b921-6da35e5e921e":{"in":"query","name":"UserID","schema":{"type":"string","description":"Only show users with this UserID.","uniqueKey":"","typeLabel":"string"},"description":"Only show users with this UserID."},"e1c38b56-005b-412d-945b-2c6c1e8af07e":{"in":"query","name":"InternalID","schema":{"type":"string","description":"Only show users with this InternalID.","uniqueKey":"","typeLabel":"string"},"description":"Only show users with this InternalID."},"fe18e17e-f293-4ddf-9abc-73ecd5525208":{"in":"query","name":"Email","schema":{"type":"string","description":"Only show users with this email address.","uniqueKey":"","typeLabel":"string"},"description":"Only show users with this email address."},"abfd9af9-5a30-40c0-876c-7d880f4bd0cf":{"in":"query","name":"FirstName","schema":{"type":"string","description":"Only show users with this first name.","uniqueKey":"","typeLabel":"string"},"description":"Only show users with this first name."},"f409bf5d-ee91-479e-83e0-90f0bd2e4fa5":{"in":"query","name":"LastName","schema":{"type":"string","description":"Only show users with this last name.","uniqueKey":"","typeLabel":"string"},"description":"Only show users with this last name."},"58e7dad6-0fe1-4930-b873-b8a78281ca55":{"in":"query","name":"AccessCode","schema":{"type":"string","description":"Only show users with this access code.","uniqueKey":"","typeLabel":"string"},"description":"Only show users with this access code."},"5a536f64-66da-45a0-837f-2178bb8a73fd":{"in":"query","name":"OrderBy","schema":{"type":"string","description":"How the results should be ordered.","uniqueKey":"","typeLabel":"string"},"description":"How the results should be ordered."},"5bf9a26d-777e-436b-9659-cf1875c6146f":{"in":"query","name":"ExcludeCustomQuestions","schema":{"type":"boolean","default":true,"description":"Exclude custom questions from results.","uniqueKey":"","typeLabel":"boolean"},"description":"Exclude custom questions from results."},"b149e57c-929e-46ee-a764-f53d8d3dbdf1":{"in":"query","name":"limit","schema":{"type":"integer","default":50,"maximum":1000,"description":"Limit number of records returned.","uniqueKey":"","typeLabel":"integer"},"description":"Limit number of records returned."},"d1e4fe07-b7bc-4ffb-98b6-8cb814164639":{"in":"query","name":"offset","schema":{"type":"integer","default":1,"description":"Offset of the first row.","uniqueKey":"","typeLabel":"integer"},"description":"Offset of the first row."},"59923c93-2d3f-4291-a7b6-90cefbea94c1":{"in":"query","name":"AssessmentKey","schema":{"type":"string","description":"Comma delimited list of AssessmentKeys.","uniqueKey":"","typeLabel":"string"},"description":"Comma delimited list of AssessmentKeys."},"28d438fe-6ab9-4e10-bc2e-1736c6714ce4":{"in":"query","name":"AdministrativeGroupKey","schema":{"type":"string","description":"Comma delimited list of AdministrativeGroupKeys.","uniqueKey":"","typeLabel":"string"},"description":"Comma delimited list of AdministrativeGroupKeys."}},"responses":{"e4f6d6ea-fe4d-49f5-a969-8ebda2297c64":{"description":"A list of users.","content":{"application/json":{"example":{"NumPages":"173","Page":"1","PageSize":"2","Total":"345","Start":"1","End":"2","FirstPageUri":"/v3/users?PageSize=2\u0026PAGE=1","LastPageUri":"/v3/users?PageSize=2\u0026PAGE=173","PreviousPageUri":"","NextPageUri":"/v3/users?PageSize=2\u0026PAGE=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"}]},"schema":{"type":"object","properties":{"NumPages":{"type":"string","description":"Total number of pages.","uniqueKey":"NumPages","typeLabel":"string"},"Page":{"type":"string","description":"Current page number.","uniqueKey":"Page","typeLabel":"string"},"PageSize":{"type":"string","description":"Number of records per page.","uniqueKey":"PageSize","typeLabel":"string"},"Total":{"type":"string","description":"Total number of records.","uniqueKey":"Total","typeLabel":"string"},"Start":{"type":"string","description":"Start record index for the current page.","uniqueKey":"Start","typeLabel":"string"},"End":{"type":"string","description":"End record index for the current page.","uniqueKey":"End","typeLabel":"string"},"FirstPageUri":{"type":"string","uniqueKey":"FirstPageUri","typeLabel":"string"},"LastPageUri":{"type":"string","uniqueKey":"LastPageUri","typeLabel":"string"},"PreviousPageUri":{"type":"string","description":"Empty string if on first page.","uniqueKey":"PreviousPageUri","typeLabel":"string"},"NextPageUri":{"type":"string","description":"Empty string if on last page.","uniqueKey":"NextPageUri","typeLabel":"string"},"User":{"oneOf":[{"type":"object","description":"One or more user records. Returns an object when there is a single result, or an array when there are multiple results.","properties":{"UserId":{"type":"string","uniqueKey":"User.oneOf.0.UserId","typeLabel":"string"},"AssessmentKey":{"type":"string","description":"The assessment key for the group the user belongs to.","uniqueKey":"User.oneOf.0.AssessmentKey","typeLabel":"string"},"AdministrativeGroupKey":{"type":"string","description":"The administrative group key for the user.","uniqueKey":"User.oneOf.0.AdministrativeGroupKey","typeLabel":"string"},"FirstName":{"type":"string","uniqueKey":"User.oneOf.0.FirstName","typeLabel":"string"},"LastName":{"type":"string","uniqueKey":"User.oneOf.0.LastName","typeLabel":"string"},"Email":{"type":"string","format":"email","uniqueKey":"User.oneOf.0.Email","typeLabel":"string\u003cemail>"},"InternalId":{"type":"string","uniqueKey":"User.oneOf.0.InternalId","typeLabel":"string"},"AccessCode":{"type":"string","description":"The user's assessment access (PIN) code.","uniqueKey":"User.oneOf.0.AccessCode","typeLabel":"string"},"CompletionPercentage":{"type":"string","description":"Percentage of the assessment completed (0-100).","uniqueKey":"User.oneOf.0.CompletionPercentage","typeLabel":"string"},"DateTimeStarted":{"type":"string","format":"date-time","uniqueKey":"User.oneOf.0.DateTimeStarted","typeLabel":"string\u003cdate-time>"},"DateTimeLastUpdated":{"oneOf":[{"type":"string","description":"Date the assessment was last updated. Empty array if not yet updated.","format":"date-time","uniqueKey":"User.oneOf.0.DateTimeLastUpdated.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.0.DateTimeLastUpdated.oneOf.1.items.[INDEX]","typeLabel":"any"},"description":"Date the assessment was last updated. Empty array if not yet updated.","uniqueKey":"User.oneOf.0.DateTimeLastUpdated.oneOf.1","typeLabel":"any[]"}],"uniqueKey":"User.oneOf.0.DateTimeLastUpdated","typeLabel":"string\u003cdate-time> | any[]"},"DateTimeCompleted":{"oneOf":[{"type":"string","description":"Date the assessment was completed. Empty array if not yet completed.","format":"date-time","uniqueKey":"User.oneOf.0.DateTimeCompleted.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.0.DateTimeCompleted.oneOf.1.items.[INDEX]","typeLabel":"any"},"description":"Date the assessment was completed. Empty array if not yet completed.","uniqueKey":"User.oneOf.0.DateTimeCompleted.oneOf.1","typeLabel":"any[]"}],"uniqueKey":"User.oneOf.0.DateTimeCompleted","typeLabel":"string\u003cdate-time> | any[]"},"HowManyCourses":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.0.HowManyCourses.items.[INDEX]","typeLabel":"any"},"uniqueKey":"User.oneOf.0.HowManyCourses","typeLabel":"any[]"},"AgeRange":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.0.AgeRange.items.[INDEX]","typeLabel":"any"},"uniqueKey":"User.oneOf.0.AgeRange","typeLabel":"any[]"},"Gender":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.0.Gender.items.[INDEX]","typeLabel":"any"},"uniqueKey":"User.oneOf.0.Gender","typeLabel":"any[]"},"Uri":{"type":"string","description":"Relative URI to retrieve this user's details.","uniqueKey":"User.oneOf.0.Uri","typeLabel":"string"}},"uniqueKey":"User.oneOf.0","typeLabel":"object"},{"type":"array","items":{"type":"object","properties":{"UserId":{"type":"string","uniqueKey":"User.oneOf.1.items.[INDEX].UserId","typeLabel":"string"},"AssessmentKey":{"type":"string","description":"The assessment key for the group the user belongs to.","uniqueKey":"User.oneOf.1.items.[INDEX].AssessmentKey","typeLabel":"string"},"AdministrativeGroupKey":{"type":"string","description":"The administrative group key for the user.","uniqueKey":"User.oneOf.1.items.[INDEX].AdministrativeGroupKey","typeLabel":"string"},"FirstName":{"type":"string","uniqueKey":"User.oneOf.1.items.[INDEX].FirstName","typeLabel":"string"},"LastName":{"type":"string","uniqueKey":"User.oneOf.1.items.[INDEX].LastName","typeLabel":"string"},"Email":{"type":"string","format":"email","uniqueKey":"User.oneOf.1.items.[INDEX].Email","typeLabel":"string\u003cemail>"},"InternalId":{"type":"string","uniqueKey":"User.oneOf.1.items.[INDEX].InternalId","typeLabel":"string"},"AccessCode":{"type":"string","description":"The user's assessment access (PIN) code.","uniqueKey":"User.oneOf.1.items.[INDEX].AccessCode","typeLabel":"string"},"CompletionPercentage":{"type":"string","description":"Percentage of the assessment completed (0-100).","uniqueKey":"User.oneOf.1.items.[INDEX].CompletionPercentage","typeLabel":"string"},"DateTimeStarted":{"type":"string","format":"date-time","uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeStarted","typeLabel":"string\u003cdate-time>"},"DateTimeLastUpdated":{"oneOf":[{"type":"string","description":"Date the assessment was last updated. Empty array if not yet updated.","format":"date-time","uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeLastUpdated.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeLastUpdated.oneOf.1.items.[INDEX]","typeLabel":"any"},"description":"Date the assessment was last updated. Empty array if not yet updated.","uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeLastUpdated.oneOf.1","typeLabel":"any[]"}],"uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeLastUpdated","typeLabel":"string\u003cdate-time> | any[]"},"DateTimeCompleted":{"oneOf":[{"type":"string","description":"Date the assessment was completed. Empty array if not yet completed.","format":"date-time","uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeCompleted.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeCompleted.oneOf.1.items.[INDEX]","typeLabel":"any"},"description":"Date the assessment was completed. Empty array if not yet completed.","uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeCompleted.oneOf.1","typeLabel":"any[]"}],"uniqueKey":"User.oneOf.1.items.[INDEX].DateTimeCompleted","typeLabel":"string\u003cdate-time> | any[]"},"HowManyCourses":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.1.items.[INDEX].HowManyCourses.items.[INDEX]","typeLabel":"any"},"uniqueKey":"User.oneOf.1.items.[INDEX].HowManyCourses","typeLabel":"any[]"},"AgeRange":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.1.items.[INDEX].AgeRange.items.[INDEX]","typeLabel":"any"},"uniqueKey":"User.oneOf.1.items.[INDEX].AgeRange","typeLabel":"any[]"},"Gender":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"User.oneOf.1.items.[INDEX].Gender.items.[INDEX]","typeLabel":"any"},"uniqueKey":"User.oneOf.1.items.[INDEX].Gender","typeLabel":"any[]"},"Uri":{"type":"string","description":"Relative URI to retrieve this user's details.","uniqueKey":"User.oneOf.1.items.[INDEX].Uri","typeLabel":"string"}},"uniqueKey":"User.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"One or more user records. Returns an object when there is a single result, or an array when there are multiple results.","uniqueKey":"User.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"User","typeLabel":"object | object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"NumPages":"173","Page":"1","PageSize":"2","Total":"345","Start":"1","End":"2","FirstPageUri":"/v3/users?PageSize=2\u0026PAGE=1","LastPageUri":"/v3/users?PageSize=2\u0026PAGE=173","PreviousPageUri":"","NextPageUri":"/v3/users?PageSize=2\u0026PAGE=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"}]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"8a24586e-869e-48c7-aaa7-e78b0946525a":{"basicAuth":{"type":"http","scheme":"basic","description":"Basic authentication with username and password","scopes":[]}}},"servers":{"b5743c61-bdb0-42c1-b80d-894970f966b6":{"url":"https://api.smartermeasure.com/v3","description":"SmarterMeasure User Service"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication with username and password","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication with username and password","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"}]},"originalFileLocation":"assessment/api/openapi.json"},"subdomain":"smarterservicesllc","siteName":"SmarterServices Platform","title":"List Users - SmarterServices Platform","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2025-09-10T18:50:39.858Z","originalFileLocation":"assessment/api/users/list-users.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get a list of users that match the specified criteria\">\u003cmeta data-mint-head name=\"application-name\" content=\"SmarterServices Platform\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"List Users - SmarterServices Platform\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get a list of users that match the specified criteria\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SmarterServices Platform\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.smarterservices.com/assessment/api/users/list-users\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smarterservicesllc.mintlify.app/_mintlify/api/og/v2?division=Users%2FAssessments\u0026amp;title=List+Users\u0026amp;description=Get+a+list+of+users+that+match+the+specified+criteria\u0026amp;theme=4042a3185e49c2c9f63be8ee\u0026amp;signature=e12e2b56e48dee1c75bb987002c294724bac3cfd5bee9b989ad5e214534bb799\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"List Users - SmarterServices Platform\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get a list of users that match the specified criteria\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smarterservicesllc.mintlify.app/_mintlify/api/og/v2?division=Users%2FAssessments\u0026amp;title=List+Users\u0026amp;description=Get+a+list+of+users+that+match+the+specified+criteria\u0026amp;theme=4042a3185e49c2c9f63be8ee\u0026amp;signature=e12e2b56e48dee1c75bb987002c294724bac3cfd5bee9b989ad5e214534bb799\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/smarterservicesllc/B1jO8o0ggqMDkB2a/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SmarterServices Platform\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#015692\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.smarterservices.com/assessment/api/users/list-users\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/assessment/api/users/list-users.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.smarterservices.com/#organization\",\"name\":\"SmarterServices Platform\",\"url\":\"https://developers.smarterservices.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://cdn.prod.website-files.com/650b016f7e13a7d9de337f22/6629053ca1393100c09aa484_SmarterServices%20Logo.png\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.smarterservices.com#website\",\"name\":\"SmarterServices Platform\",\"url\":\"https://developers.smarterservices.com\",\"publisher\":{\"@id\":\"https://developers.smarterservices.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.smarterservices.com/assessment/api/users/list-users#webpage\",\"url\":\"https://developers.smarterservices.com/assessment/api/users/list-users\",\"name\":\"List Users\",\"description\":\"Get a list of users that match the specified criteria\",\"dateModified\":\"2025-09-10T18:50:39.858Z\",\"isPartOf\":{\"@id\":\"https://developers.smarterservices.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.smarterservices.com/assessment/api/users/list-users#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.smarterservices.com/assessment/api/users/list-users#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://developers.smarterservices.com/assessment/api/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Users/Assessments\",\"item\":\"https://developers.smarterservices.com/assessment/api/users/create-user\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List Users\",\"item\":\"https://developers.smarterservices.com/assessment/api/users/list-users\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.smarterservices.com/assessment/api/users/list-users#apireference\",\"headline\":\"List Users\",\"name\":\"List Users\",\"description\":\"Get a list of users that match the specified criteria\",\"url\":\"https://developers.smarterservices.com/assessment/api/users/list-users\",\"mainEntityOfPage\":{\"@id\":\"https://developers.smarterservices.com/assessment/api/users/list-users#webpage\"},\"dateModified\":\"2025-09-10T18:50:39.858Z\",\"publisher\":{\"@id\":\"https://developers.smarterservices.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.smarterservices.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SmarterServices Platform\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SmarterServices Platform","nav":{"global":null,"tabs":[{"tab":"Platform","icon":"layer-group","pages":[{"title":"Platform","href":""}]},{"tab":"Assessment","icon":"pen-to-square","groups":[{"group":"API Reference","pages":[{"title":"Introduction","href":"/assessment/api/introduction"},{"title":"Authentication","href":"/assessment/api/authentication"},{"title":"Error Messages \u0026 Codes","href":"/assessment/api/errors"},{"group":"Users/Assessments","icon":"building","pages":[{"title":"Create User","openapi":"POST /users","href":"/assessment/api/users/create-user"},{"title":"Update User","description":"Update a specific user","openapi":"PUT /users/{userid}","href":"/assessment/api/users/update-user"},{"title":"List Users","openapi":"GET /users","href":"/assessment/api/users/list-users"},{"title":"Get User","description":"Get a specific user","openapi":"GET /users/{userid}","href":"/assessment/api/users/get-user"},{"title":"Sign On","openapi":"POST /users/{userid}/signon","href":"/assessment/api/users/signon"},{"title":"Report Link","openapi":"GET /users/{userid}/reportlink","href":"/assessment/api/users/report-link"}]},{"group":"Results","icon":"building","pages":[{"title":"User Results","openapi":"GET /users/{userid}/results","href":"/assessment/api/results/user-results"},{"title":"User Report","openapi":"GET /users/{userid}/report","href":"/assessment/api/results/user-report"},{"title":"Search Results","openapi":"GET /results","href":"/assessment/api/results/search"},{"title":"Search Results (expanded)","openapi":"GET /results/new","href":"/assessment/api/results/search-expanded"}]}]},{"group":"Webhooks","pages":[{"title":"Getting Started","icon":"rocket","href":"/assessment/webhooks/getting-started"},{"title":"Events \u0026 Payloads","icon":"code","href":"/assessment/webhooks/events-and-payloads"},{"title":"Testing \u0026 Troubleshooting","icon":"bug","href":"/assessment/webhooks/testing-and-troubleshooting"}]}]},{"tab":"Proctoring","icon":"camera-security","pages":[{"title":"Proctoring","href":"/proctoring/introduction"}]},{"tab":"SmarterElements","icon":"puzzle-piece","pages":[{"title":"SmarterElements","href":"/smarter-elements/overview"}]},{"tab":"Blog","icon":"book","href":"https://www.smarterservices.com/blog"}]},"basePath":"","title":"List Users - SmarterServices Platform","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}