LUlumahealth
offers

Get offer by id

get/offers/{offerId}

Request

Path parameters

offerIdstring required

Offers' unique identifier in Luma's database.

Response

Offer

_idstring

Luma's internal ID of an object.

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.

providerstring

The ID of provider

datestring date-time

Date of the offer

durationinteger

ID of Setting

facilitystring

The ID of facility

approvedBystring

The ID of approvedBy

declinedBystring

The ID of declinedBy

currentWaitlistinteger

current Waitlist of the offer

expireAtstring date-time

When the offer will expire

patientFoundAtstring

The ID of patientFoundAt

patientFoundstring

The ID of patientFound

estimatedCompletionAtstring date-time

When the offer will be estimated complete

shadowAppointmentstring

The ID of shadowAppointment

availabilitystring

The ID of availability

protocol'serial' | 'parallel'

Protocol of the offer

offerstring

The ID of offer

usedForAppointmentstring

The ID of usedForAppointment

rescheduledFromAppointmentstring

The ID of rescheduledFromAppointment

patientFormstring

The ID of patientForm

patientFormTemplatestring

The ID of patientFormTemplate

referralstring

The ID of referral

integratorCreationResultsobject

Integrator Creation Results

source'cancellation' | 'manual' | 'find-open-spots' | 'self-scheduling' | 'reschedule' | 'staff-scheduling' | 'reschedule-from-intent'

Source of the offer

status'in-progress' | 'patient-found' | 'patient-not-found' | 'cancelled'

Status of the offer

Changes

No recorded changes to this operation across all 6 revisions of this API.