latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

users

List users

get/users

Query parameters

namestring

Full name of the staff user

firstnamestring

First name

lastnamestring

Last name

middlenamestring

Middle name

alternativeNamestring

Alternative name

displayPhonestring

Phone number displayed in staff profile. Not used for communication purposes.

displayStatus'active' | 'pending' | 'suspended'

Account status. Informative field only, not used for access control.

emailstring

User's e-mail address in lowercase.

roles'staff' | 'doctor' | 'widget' | 'manager' | 'admin' | 'referringProvider' | 'renderingProvider' | 'subaccount' | 'readFileUpload'

User's roles, used for access control.

doNotContactboolean

Indicates if the user has requested not to be contacted by Luma.

doNotContactMessagestring

The unique ID of the inbound message that requested DNC.

stripeCustomerIdstring

Customer ID from stripe for this account

stripeSubscriptionIdstring

Stripe subscription ID

salesforceIdstring

Salesforce Account ID for this account

activenumber

Indicates if a user is active and able to log into the system or not.

languagestring

User's preferred language.

addressstring

User's address.

citystring

User's city.

statestring

User's state.

countrystring

User's country

postcodestring

User's postal code.

gender'male' | 'female' | 'unknown' | 'nonbinary'

User's gender.

avatarstring

The ID of a FileUpload containing the profile picture of the user.

directMessagingEmailstring

E-mail for direct communication with the user.

websitestring

User's website.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

pageinteger
limitinteger

How many items to fetch per page

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

Response

List of users

pageinteger required
sizeinteger required