Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel7

GET /users

Filter Parameters

Parameter

Type

Description

id

int|int[]|string

E.g:

123 or “1234,1235" or [1234, 1235]

full_name

String

Full text search (minimum 3 chars)

email

String

Like search (minimum 3 chars)

q

String

Search keyword (minimum 3 chars)

full_name like q or email like q

ex_filter

String

all or my-patient

all: filter by assigned rooms

my-patient: filter by own visits

is_hidden

Boolean

[RPM][New] Hide/Unhide patient from patient list

is_admin

Boolean

status

int|int[]|string

Status, e.g:

20 or “10,20" or [10, 20]

type

int|int[]|string

User type, e.g:

400 or “200,600" or [200, 600]

role

string|string[]

Role, e.g:

"clinic_admin" or "clinic_admin,scheduler" or ["clinic_admin", "scheduler"]

room_code

account_code

group

Clinic group

subtype

Provider sub type

Other Parameters

Parameter

Type

Description

sort

string|object

E.g:

“full_name.asc" or {full_name: "asc"}

start

int

Offset

limit

int

Page size

fields

string|string[]

E.g:

"username,full_name" or ["username", "full_name"]

POST /users/sso

Single Sign On for patient and provider.

...

Code Block
"vsee": {
    "id": "ccpreview+606ce3e353c8411a8e7b52c664457b1f",
    "token": "78fc497ff743d2b51050d9102acabe63"
}

Parameters

Parameter

Type

Description

first_name

String

Required

last_name

String

Required

dob

String

Optional

type

Integer

200: Member, 400: Provider, 600: Guest User

code

String

Required if type is 200 or 400 / Max length: 128 character
code is a unique user identifier on your end. VSee will store the code for this user record and next time you call SSO, we will return you the same existing user.

email

String

Optional

username

String

Optional - system will generate one as fallback

disable_emails

Integer

Optional - set to 1 - if you want user to disable all email notification

Response

Note: you can use the data.token.token return here to redirect user from your portal to VSee Clinic portal, please see Workflows section.

...

Log user in and retrieve access token

Notes:

  1. user_type will be member(200), provider(400), …, etc

  2. There is 2 methods for log in

    1. active user

      1. use username and password field

    2. inactive user

      1. user email and email token sent to their email

      2. only after user update their password via API, their status will change to active and can log in via active user log in method above.

Parameters

Parameter

Type

Description

username

String

(for active user only)

password

String

(for active user only)

email

String

(for non-active user who has not set the password yet)

email_token

String

(for non-active user who has not set the password yet)

...