Versions Compared

Old Version 20

changes.mady.by.user Anton Tolkachiov

Saved on

compared with

New Version Current

changes.mady.by.user Anton Tolkachiov

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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

Should be used in conjunction with type

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

...

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,last_login" or ["username", "full_name"]

Available fields params

  • id

  • username

  • first_name, last_name, full_name

  • last_login

  • type, subtype

Response:

Code Block
breakoutModewide
curl --location 'https://api-vclinic.vseepreview.com/vc/stable/api_v3/users?q=anton%2Bpatient1%40vseelab.com&type=200' \
--header 'X-ApiToken: vclinic_api_token' \
--header 'X-AccountCode: vclinic'
{
    "data": [
        UserObject{
          "email": "anton+patient1@vseelab.com",
        UserObject  "id": "20008869839",
          "full_name": "Anton UserObject,Patient1"
        UserObject},
        UserObject...
    ],
    "total_count": 500
}

GET /users/:id
Status
colourYellow
titleV3

...

Parameter

Type

Description

first_name

String

Required

last_name

String

Required

dob

String

Optional

YYYY-MM-DD format

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

POST Parameters required in order to be able to e-prescribe for this user

...

Parameter

Type

Description

first_name

String

Required

last_name

String

Required

dob

String

Required

YYYY-MM-DD format

type

Integer

200: Member

code

String

Required

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.

gender

String

Required

male / female

street_addr

String

Required

city

Integer

Required

state

String

Required

Two-Letter State Abbreviation

zip

String

Required

phone

String

Required

...