Skip to main content
GET

Overview

Returns a paginated list of users in your organisation. In the Voxmind data model, a “user” is any person who has been enrolled — they have a record in Voxmind’s system tied to your external_id mapping. This endpoint is primarily useful for auditing your enrolled user base, checking active status, and integrating with your own user management dashboard.
Voxmind users are identified by your external_id, not by any email or identity field. Voxmind does not store personal data about your users — just the external_id and voiceprint. Your application is responsible for mapping external_id to real users.

Path Parameters

string
required
Your organisation’s unique identifier.

Query Parameters

string
Filter conditions. Useful patterns: filter=is_active=true (enrolled active users only), filter=external_id=like:user_% (users with a specific ID prefix).
string
Example: sort=created_at:desc
integer
default:"100"
Results per page. Maximum 300.
integer
default:"1"
Page number. Total pages available in X-Total-Pages response header.