Getting Started
- What is TestInvite?
- Build Your First Test
- Run Your First Assessment
- Taking the Assessment
- Viewing the Results
- Question Bank Overview
- Common Question Features
- Scoring
- Question Types
- Question Authoring
- Browsing Questions
- Content Blocks
- Media Library
- Metadata Rules & Schema
- Roles & Access
- Tests Overview
- My Tests
- Creating a Test
- The Test Editor
- Test Settings
- Sections & Pages
- Adding Questions
- Page Builders
- Test Profile
- Reporting
- Test Papers
- Analytics
- Publishing a Test
- Test Library
- Marketplace
- Tasks Overview
- Creating a Task
- Task Dashboard
- Steps
- Task Settings
- Candidates
- Test Sessions
- Sent Mails
- Proctoring
- Analytics
- Analytics Overview
- Test Analytics
- Question Analytics
- Per-Question Analytics
- Results Explorer
- Segment Analysis
Integrations
REST API Reference
Users
List, fetch, search, and expand Users through the REST API — teammates and learners across your whole organization, not scoped to a single task.
Published 2026/08/26
Requires the List users permission. Users are org-wide — unlike Candidates, they aren't scoped to a single task. There's currently no create or update endpoint for Users through this API. See REST API Reference for the shared mode, pagination, and List/Fetch/Search conventions used below.
Basic vs. Detailed
- basic —
userId, createdAt, username, fullname, email - detailed — adds
organizationId, folder, tags, labels, group, favorite, active, roles[].rolesis any combination of Manager, Test Author, Task Operator, Custom Access User, Question Curator, External Question Author.
List, Fetch, Search
GET /users— query params:mode, limit, page, username(case-insensitive partial match).GET /users/:id— query param:mode.POST /users/filter— query params:mode, limit, page; body:{ folder?, group?, labels?, favorite?, type?, username?, active? }, all AND-combined.typeis"teammate"or"regular"(learner);activeis whether the user can currently log in.
Expand
POST /users/:id/expand — body: { expand: ["activeAfter", "activeBefore"] }. Returns the detailed user plus activeAfter/activeBefore — the window during which this user can sign in, if one is set.