Versions Compared

Key

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

...

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:

Code Block
{
    "data": [
        UserObject,
        UserObject,
        UserObject,
        UserObject,
        UserObject
    ],
    "total": 500
}

POST /users/sso

Single Sign On for patient and provider.

...