User API

get /users

List users

Base URL https://api.vseepreview.com/api_v3 · operationId getUsers

Authentication: Admin Token — Requires the Clinic Admin API Token from your dashboard (Developers → App → Edit App).

Retrieve a list of users with optional filtering and sorting.

Tip: Wherever there's a user :id field in API methods, it also accepts dash (-) as a mapping to the current user.

Parameters

Name	In	Type	Required	Enum	Default	Description
X-ApiToken	header	string	yes			API token (e.g. your_api_token)
X-AccountCode	header	string	yes			Account code (e.g. vclinic)
id	query	string	no			Filter by user ID(s). Accepts single ID, comma-separated string, or array. E.g: `123` or `"1234,1235"` or `[1234, 1235]` (e.g. 123)
full_name	query	string	no			Full text search by name (minimum 3 characters)
email	query	string	no			Like search by email (minimum 3 characters)
q	query	string	no			Search keyword (minimum 3 chars). Searches `full_name` and `email`. Should be used in conjunction with `type`. (e.g. anton+patient1@vseelab.com)
type	query	string	no			User type. E.g: `400` or `"200,600"`. Types: 100=Admin, 200=Member, 400=Provider, 600=Guest (e.g. 200)
status	query	string	no			User status. Accepts single value, comma-separated, or array. E.g: `20` or `"10,20"`
role	query	string	no			Filter by role. E.g: `"clinic_admin"` or `"clinic_admin,scheduler"`
ex_filter	query	string	no	all, my-patient		Extended filter: `all` (filter by assigned rooms) or `my-patient` (filter by own visits)
is_hidden	query	boolean	no			Hide/Unhide patient from patient list (RPM feature)
is_admin	query	boolean	no			Filter admin users
room_code	query	string	no			Filter by room code
account_code	query	string	no
group	query	string	no			Filter by clinic group
subtype	query	string	no			Provider sub type. Values: 480=Paramedic, 482=Doctor, 484=Nurse, 470=CSR, 460=Medical Assistant
sort	query	string	no			Sort order. E.g: `"full_name.asc"` or `{full_name: "asc"}` (e.g. full_name.asc)
start	query	integer	no		0	Offset for pagination
limit	query	integer	no		20	Page size for pagination
fields	query	string	no			Comma-separated fields to return. Available: `id`, `username`, `first_name`, `last_name`, `full_name`, `last_login`, `type`, `subtype` (e.g. username,full_name,last_login)

Responses

200 — Successful response

List members (type=200) — List all members (patients)

{
  "data": [
    {
      "email": "anton+patient1@vseelab.com",
      "id": "20008869839",
      "full_name": "Anton Patient1"
    },
    {
      "email": "anton+patient2@vseelab.com",
      "id": "20008869840",
      "full_name": "Anton Patient2"
    }
  ],
  "total_count": 500
}

List providers (type=400) — List all providers

{
  "data": [
    {
      "email": "doctor+1@vseelab.com",
      "id": "20008870001",
      "full_name": "Dr. Jane Smith"
    },
    {
      "email": "doctor+2@vseelab.com",
      "id": "20008870002",
      "full_name": "Dr. John Doe"
    }
  ],
  "total_count": 25
}

Search by email — Filter users by email with type

{
  "data": [
    {
      "email": "anton+patient1@vseelab.com",
      "id": "20008869839",
      "full_name": "Anton Patient1"
    }
  ],
  "total_count": 1
}

400 — Bad Request

{
  "code": 404,
  "message": "Sorry, this page is not available."
}

401 — Unauthorized

{
  "code": 404,
  "message": "Sorry, this page is not available."
}

Machine-readable: OpenAPI JSON (operationId: getUsers)