v2

latestOpenAPI 3.0.02026-07-2632977728.5 KB
Administrative

Retrieve an existing user, /api/users/current can be used to identify logged in user, it will redirect to /api/users/{current_user_id}

get/api/users/{id}

Path parameters

idstring required

Query parameters

doctorinteger

Response

OK

usernamestring
doctorstring

For staff members, this is their primary physician's ID. For doctors, it is their own ID.

practice_groupstring

The ID of the practice group this user belongs to. This can be used to identify users in the same practice.

is_doctorstring

Mutually exclusive with is_staff

is_staffstring

Mutually exclusive with is_doctor

staffinteger nullable

The ID used by /api/staff. This will be null if is_staff is false.

idstring
permissionsstring

Permissions the user has.