Skip to main content
GET
https://api.voxmind.ai
/
organisations
/
{orgId}
/
users
curl -X GET "https://api.voxmind.ai/organisations/42/users?filter=is_active=true&sort=created_at:desc&per_page=50" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

{
  "results": [
    {
      "id": 1001,
      "org_id": 42,
      "external_id": "user_98765",
      "is_active": true,
      "created_at": "2025-02-10T09:15:00Z",
      "updated_at": "2025-02-10T09:15:00Z"
    },
    {
      "id": 1002,
      "org_id": 42,
      "external_id": "user_11223",
      "is_active": true,
      "created_at": "2025-02-11T14:30:00Z",
      "updated_at": "2025-02-11T14:30:00Z"
    }
  ]
}

​
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

​
orgId
string
required
Your organisation’s unique identifier.

​
Query Parameters

​
filter
string
Filter conditions. Useful patterns: filter=is_active=true (enrolled active users only), filter=external_id=like:user_% (users with a specific ID prefix).
​
sort
string
Example: sort=created_at:desc
​
per_page
integer
default:"100"
Results per page. Maximum 300.
​
page
integer
default:"1"
Page number. Total pages available in X-Total-Pages response header.
curl -X GET "https://api.voxmind.ai/organisations/42/users?filter=is_active=true&sort=created_at:desc&per_page=50" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

{
  "results": [
    {
      "id": 1001,
      "org_id": 42,
      "external_id": "user_98765",
      "is_active": true,
      "created_at": "2025-02-10T09:15:00Z",
      "updated_at": "2025-02-10T09:15:00Z"
    },
    {
      "id": 1002,
      "org_id": 42,
      "external_id": "user_11223",
      "is_active": true,
      "created_at": "2025-02-11T14:30:00Z",
      "updated_at": "2025-02-11T14:30:00Z"
    }
  ]
}