appointments5

appointmentTypes5

assistantActions5

assistantInstances8

assistantTransferRules1

auth5

availabilities4

billingCharges5

billingCopays6

Broadcast Templates6

broadcastEvents4

broadcastFlows9

campaigns4

chatActivities4

chatActivitiesReasons5

chatAudits5

checklists7

checklistTemplates8

customWebStyles5

engagementEvents2

engagements8

engagementSettings5

estimates5

facilities5

feedbackResponses2

feedbackResponsesExternalReviewReplies2

feedbackResponsesExternalReviews2

feedbackResponsesPromoterHistories2

fileUploadRecords4

fileUploads5

groups5

insurancePayors7

insurances5

knowledgeBaseQuestionAnswers5

lumabotFlows12

lumabotFlowTemplates5

messages4

messageTemplatePartials5

offers5

outboundReferrals5

patientCreditCards5

patientFormPdfFilledDocuments5

patientFormPdfTemplates5

patientForms4

patientFormTemplates6

patientMessageTemplates5

patients7

providers5

providerSchedulingGroups5

queueManagerInstances1

recalls5

referrals6

reminders5

reports5

schedulers1

settings3

specialties14

squigglies1

systemAudits1

users5

waitlists5

patients

Show a list of patients

Changed on Oct 17, 2026

get/patients

Request

Base URL
https://api.lumahealth.io/api/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/lumahealth/apis/rest-service/docs/patients/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

culture'cn' | 'hk'

birthSex'M' | 'F' | 'UNK'

ethnicityGroup'hispanic-or-latino' | 'not-hispanic-or-latino'

suffix'II' | 'III' | 'IV' | 'Jr.' | 'Sr.'

previousAddressstring

lastProcessedAtstring date-time

source'widget' | 'integrator' | 'ui' | 'referring-provider' | 'hub'

widget'lumabot'

mergedIntostring

createdBystring

updatedBystring

deletedBystring

deletedAtstring date-time

primaryCareProviderstring

balancenumber

balanceUpdatedAtstring date-time

searchIdsstring[]

randomNameboolean

_idstring

namestring

normalizedNamestring

firstnamestring

lastnamestring

middlenamestring

displayPhonestring

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

emailstring

safeIdstring

type'doctor' | 'staff' | 'patient' | 'guest'

rolesstring[]

organizationstring

doNotContactboolean

doNotContactMessagestring

groupsstring[]

stripeCustomerIdstring

stripeSubscriptionIdstring

salesforceIdstring

deletednumber

createdAtstring date-time

updatedAtstring date-time

lastLoginstring date-time

activenumber

masterboolean

languagestring

userstring

settingstring

settingsunknown

addressstring

citystring

statestring

countrystring

postcodestring

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

allowedIpsstring[]

avatarstring

publicKeystring

directMessagingEmailstring

websitestring

patientGlobalSearchstring

Search for a patient within the resource using the current parameters Luma Patient ID (patient._id), MRN (patient.medicalRecordNumber), Name combos(patient.firstname, patient.lastname) OR (patient.lastname,patient.firstname), All contact method (phone number and email - active OR not), ExternalID (patient.externalId.value), Date of Birth.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

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.

searchByNameOrDobOrPhoneNumberstring

If this parameter is passed, we perform a search by name or DOB or Phone Number, limited by parameter 'limit' and ignoring all other parameters.

Response

Returns a list of patients

pageinteger required

sizeinteger required

Changes

Oct 17, 2026f19aeba84a26 Revision changes
- warning
  deleted the query request parameter createdAt
- warning
  deleted the query request parameter createdBy
- warning
  deleted the query request parameter deleted
- warning
  deleted the query request parameter updatedAt
- warning
  deleted the query request parameter updatedBy
- warning
  deleted the query request parameter user
- info
  added the new optional query request parameter createdAt
- info
  added the new optional query request parameter createdBy
- info
  added the new optional query request parameter deleted
- info
  added the new optional query request parameter updatedAt
- info
  added the new optional query request parameter updatedBy
- info
  added the new optional query request parameter user
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property // to the response with the status
Aug 23, 2026d3c75c2a2f1d Revision changes
- warning
  deleted the query request parameter createdAt
- warning
  deleted the query request parameter createdBy
- warning
  deleted the query request parameter deleted
- warning
  deleted the query request parameter updatedAt
- warning
  deleted the query request parameter updatedBy
- warning
  deleted the query request parameter user
- info
  added the new optional query request parameter createdAt
- info
  added the new optional query request parameter createdBy
- info
  added the new optional query request parameter deleted
- info
  added the new optional query request parameter updatedAt
- info
  added the new optional query request parameter updatedBy
- info
  added the new optional query request parameter user

Operation history (5 revisions)

Show a list of patients

Request

Query parameters

Response 200OK

Changes

Response