...
| Code Block |
|---|
{
"data": [
UserObject,
UserObject,
UserObject,
UserObject,
UserObject
],
"total": 500
} |
GET /users/:id
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"]
Response:
...
Get profile’s data of a particular user, including fields from the extended profile (if any).
Response:
| Code Block |
|---|
curl --location --request GET 'https://api-vclinic.vsee.me/api_v3/users/27769243' \ --header 'X-ApiToken: xxxxxxxxxxxxx' \ --header 'X-AccountCode: vclinic' { "data": { "id": "27769243", "code": "63f67706de344db98a6461d00adc646e", "first_name": "anton", "last_name": "test_2", "full_name": "anton test_2", "username": "anton+test2@vseelab.com", "vseeid": "cmo+user27769243", "dob": "1980-01-01", "email": "anton+test2@vseelab.com", "gender": 1, "active": true, "tos": true, "status": 20, "subtype": "", "timezone": "Europe/Berlin", "email_verified": true, "signup_step": 99, "extra": { "marital_status": "married", "gender_identity": "Choose Not To Disclose", "social_security_no": "", "veteran": "", "race": "", "ethnicity": "", "health_insurance": "", "insurance": "", "insurance_policy_number": "", "attachments": null, "emerg_contact_name": "" }, "dashboard_url_alternative": "/u/uat", "account_code": "vclinic", "clinics": [ "vclinic" ], "rooms": [ { "id": "865244556", "code": "vclinic_room_code", "slug": "uat", "name": "UAT", "account_code": "vclinic", "domain": "vclinic.vsee.me", "default": true, "added_time": 1677096710, UserObject, "source": "signup" UserObject, UserObject,} UserObject], UserObject "created": 1677096710, ], "totaltype": 500 200 } } |
POST /users/sso
Single Sign On for patient and provider.
...