CLclinicos
Users

Get primary providers sorted by display order (for schedule team view)

Changed on
get/Users/primary-providers

Request

Response

OK

idstring
emailstring
displayNamestring nullable
firstNamestring
lastNamestring
typeinteger
createdAtstring date-time
updatedAtstring date-time nullable
lastLoginAtstring date-time nullable
isActiveboolean
roleIdstring nullable
roleNamestring nullable
permissionsstring[] nullable
invitedAtstring date-time nullable
passwordResetRequiredboolean
mentorIdstring nullable
mentorNamestring nullable
mentorshipStartDatestring date-time nullable
isMentorshipActiveboolean
isPrimaryProviderboolean
careTeamRolestring nullable

The care-team role (a CareTeamRole name) this user defaults to when added to an appointment's care team (ITE-1060): the role's explicit mapping, else the fallback from CareTeamRoles.DefaultFor. Lets the care-team picker show the same default the server would apply.

deaNumberstring nullable
licenseNumberstring nullable
licenseStatestring nullable
usdaNumberstring nullable
deaLicenseExpiryDatestring date-time nullable
stateLicenseExpiryDatestring date-time nullable
usdaLicenseExpiryDatestring date-time nullable
signatureImagestring nullable

The provider's stored signature as a data:image/...;base64, data URL, applied to generated documents (e.g. the vaccine certificate). Null when none on file.

defaultExamTemplateIdstring nullable

Provider's selected default exam template id, or null to use the built-in 7-system view.

noteStyleInstructionsstring nullable

This clinician's personal note house style, or null when they defer entirely to the practice-wide setting. Applied on top of the practice preference, never instead of it.

Changes

  • 021fabd866ffRevision changes
    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)

  • 503cd0546309Revision changes
    • info

      added the optional property / to the response with the status (media type: text/plain)

    • info

      added the optional property / to the response with the status (media type: application/json)

    • info

      added the optional property / to the response with the status (media type: text/json)