LabStack

Provider API

v1.0.28Sign in

Authentication

API key issued by LabStack. Pass this in every request header. Your store can hold two active keys at once, so you can move to a new key before the old one is revoked. A key may have an expiry date; a request made with an expired or revoked key is refused as unauthorized. Header: ls-api-key

API for integrating telehealth and in-person provider consultations — speciality discovery, provider search, appointment booking, document management, and video consultations. All requests must include a valid ls-api-key header.

Instant consult webhooks

If you give us a webhook URL and a signing secret, we POST a small JSON notification to it as an instant consult moves on, so you do not have to poll getInstantStatus to the end. Delivery is at least once: the same event may arrive twice, so treat requestId and event together as the key and make handling them repeatable. A delivery that fails is retried for a while and then given up on, so treat the webhook as a prompt to pull rather than as the only way you will hear.

Events

eventMeaning
consult.claimedA doctor accepted the request. Call getInstantStatus for the joining link.
consult.expiredThe request reached its expiresAt with no doctor.
consult.canceledThe request was withdrawn.
consult.doctor_no_showThe doctor who accepted never joined; the request is open again.
meeting.endedThe consultation call finished.
consult.completedThe consultation was completed.
prescription.readyA prescription is available for the consultation.

Body

json
{ "event": "consult.claimed", "requestId": 4821, "appointmentId": 91245, "storeId": 17, "ts": "2026-09-27T10:31:04.000Z" }

It deliberately carries no patient details — it tells you that something changed and which request it was, and you read the rest from the API.

Verifying it came from us

Every delivery carries an x-labstack-signature header: the HMAC-SHA256 of the raw request body, keyed with your signing secret, hex encoded. Compute the same over the body exactly as received, before any parsing or re-serialising, and compare using a constant-time comparison. Reject anything that does not match.

Admin

Get wallet balance

Returns the store's LabStack wallet balance (currently a stub returning 0).

Responses

200

Success

{
statusstring
walletBalanceinteger
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "walletBalance": 0
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/admin/getBalance' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Service health check

Verifies database connectivity.

Responses

200

Success

{
statusstring
healthyboolean
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
503

Service unhealthy

Sample response
{
  "status": "success",
  "healthy": true
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/admin/status' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Appointment

Book an appointment

Creates an appointment (ONLINE teleconsult, HOME_VISIT, or CENTER_VISIT) with a provider or provider group for the authenticated store. Provide either lsProviderId or lsGroupId. The patient's gender and dateOfBirth (or age) are optional. For a patient already on record (same uniqueId), a booking only fills in a gender or date of birth not yet recorded and never changes a recorded one; use POST /api/admin/v1.0/user/updateUserDetails to change them. Supports follow-up bookings and an optional pre-appointment payment link, which defaults to the amount payable for the booking unless a lower paymentAmount is supplied. That link is valid for 16 minutes and the appointment is auto-cancelled if payment is not completed in that window. The store's appointment discounts (see GET /api/v1.0/availability/getDiscounts) are applied automatically to a booking with a confirmed provider slot and procedure; pass couponCode to use one that needs a code. At most one discount applies, and the response's discount object says which. Follow-ups and provider-group bookings never take a discount. storeSuggestedTestIds and storeSuggestedPackageIds recommend lab tests and packages to the doctor. They are shown ahead of everything else when the doctor writes the prescription for this appointment, and the doctor decides whether to prescribe them. They can only be set when booking. Some providers need a ten-digit Indian mobile number that is the patient's own, not shared with another patient such as the main user, a valid email address, and the patient's gender and date of birth (sent as gender and dateOfBirth or age, or already on record for the patient), and cannot take paymentAmount, couponCode or isFollowUp. A booking with one of them that cannot meet this fails with 400 saying why, and nothing is booked. With isPaymentRequired they are charged the price they are listed at, and the patient can check in at the clinic only once the payment link is paid; a provider whose visits are paid at the clinic returns no link. Rarely a booking cannot be completed right now: it then fails with 500, nothing stays booked, and trying again is safe. checkInUrl is the patient's clinic check-in link. At the clinic, the patient opens it and checks in by scanning the QR code at the reception, or by typing the code printed under it where there is one. Check-in opens on the day of the appointment. Once the patient checks in, the appointment is CHECKED_IN with customerArrivalTime set, and your appointments webhook is sent. checkInUrl is set for a CENTER_VISIT at a clinic that offers check-in, and is null otherwise. When it is set, send it to the patient before the visit or open it in your app, as they need it at the clinic; getAppointmentDetails returns it too. Ask your account manager about turning on clinic check-in for your providers.

Request bodyRequired

{
lsProviderIdintegerOptional
lsGroupIdintegerOptional

alternative to lsProviderId

lsProcedureIdintegerOptional
preferredGenderstringOptional
Enum:MALEFEMALE
appointmentTypestringRequired
Enum:ONLINECENTER_VISITHOME_VISIT
referenceIdstringOptional

optional external ref

appointmentstring · date-timeRequired
notesstringOptional
uniqueIdstringOptional

optional; auto-generated if omitted

namestringRequired
emailstring · emailRequired
mobilestringRequired

10 digits

altContactstringOptional
dateOfBirthstring · dateOptional

Optional. Cannot be in the future. Takes precedence over age when both are given. Ignored if the patient already has a date of birth on record.

ageintegerOptional

Optional. Whole years, used when dateOfBirth is not given. Ignored if the patient already has a date of birth on record.

genderstringOptional
Enum:MALEFEMALEOTHERS

Optional. Ignored if the patient already has a gender on record.

mainUserUniqueIdstringOptional
relationshipstringOptional
Enum:OTHERHUSBANDWIFEFATHERMOTHERSONDAUGHTERGRANDFATHERGRANDMOTHERGRANDSONGRANDDAUGHTERSON_IN_LAWDAUGHTER_IN_LAWBROTHERSISTERBROTHER_IN_LAWSISTER_IN_LAWUNCLEAUNTCOUSINNEPHEWNIECEMOTHER_IN_LAWFATHER_IN_LAWPARTNERFRIENDNEIGHBOUR
unitFloorBuildingstringOptional
addressstringOptional

required for HOME_VISIT

localitystringOptional
citystringOptional

required for HOME_VISIT

statestringOptional

required for HOME_VISIT

pincodestringOptional

required for HOME_VISIT/CENTER_VISIT

latitudenumberOptional
longitudenumberOptional
meetingTypestringOptional
Enum:VIDEOAUDIO_ONLY

teleconsultation; default VIDEO

isPaymentRequiredbooleanOptional

Optional. If true a payment link valid for 16 minutes is returned, and the appointment is auto-cancelled (releasing the slot) if it is not paid within that window. Defaults to false.

paymentAmountnumberOptional

Optional. Amount (in INR) the customer is asked to pay, used only when isPaymentRequired is true. Must be greater than 0, have at most 2 decimal places, and must not exceed the amount payable for the booking: the configured cost of the procedure on the booked slot, less any discount. Omit to charge that amount. Not supported for provider-group requests, which have no confirmed slot.

couponCodestringOptional

Optional. A coupon code for one of the store's appointment discounts. Matched without regard to case. If the coupon cannot be used on this booking, or has reached its usage limit, the request fails with 400 and no appointment is created.

isFollowUpbooleanOptional

requires previousAppointmentId

previousAppointmentIdintegerOptional
storeSuggestedTestIdsarray<string>Optional

Optional. LabStack test ids (the lsId of a test in the Labs API catalogue) to recommend to the doctor when writing a prescription. Duplicates are ignored. At most 50 ids across storeSuggestedTestIds and storeSuggestedPackageIds combined. An id not in the catalogue, or more than 50 in all, fails with 400 and nothing is booked.

storeSuggestedPackageIdsarray<string>Optional

Optional. LabStack package ids (the packageId of a package in the Labs API catalogue) to recommend to the doctor when writing a prescription. Duplicates are ignored. At most 50 ids across storeSuggestedTestIds and storeSuggestedPackageIds combined. An id not in the catalogue, or more than 50 in all, fails with 400 and nothing is booked.

}

Responses

200

Appointment booked

{
statusstring
appointmentobject
{
appointmentIdinteger
appointmentStatusstring
Enum:CREATEDCONFIRMEDPENDING

CREATED when the booking is waiting for the provider to confirm it, which is the default. CONFIRMED when the provider has auto-confirmation switched on, in which case no further action is needed. PENDING when the appointment still requires payment.

appointmentTypestring
referenceIdstring | null
lsGroupIdinteger | null
lsProviderIdinteger | null
providerNamestring | null
meetingLinkstring | null
followUpDaysinteger | null

Free follow-up window (days) starting from this appointment; null if not configured or this booking is itself a follow-up

followUpUntilstring | null
isFollowUpboolean
storeSuggestedTestIdsarray<string>

The suggested test ids as saved, trimmed and without duplicates; empty when none were given.

storeSuggestedPackageIdsarray<string>

The suggested package ids as saved, trimmed and without duplicates; empty when none were given.

checkInUrlstring | null

The patient's clinic check-in link; null when the visit is not offered check-in.

apiErrorstring | null
}
uniqueIdstring
paymentLinkstring | null

Only returned when isPaymentRequired is true. Valid for 16 minutes from booking.

paymentLinkExpiresAtstring | null

Only returned when isPaymentRequired is true. Always 16 minutes after booking; the appointment is cancelled at this point if unpaid.

previousAppointmentIdinteger | null
discountobject | null

The discount applied to this booking; null when none applied.

{
discountIdstring
namestring
couponCodestring | null

The coupon the discount required; null for a discount applied automatically.

baseAmountnumber

The configured cost of the procedure before the discount (INR).

discountAmountnumber

The amount taken off (INR).

payableAmountnumber

What the booking costs after the discount (INR).

}
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "appointment": {
    "appointmentId": 47585,
    "appointmentStatus": "CREATED",
    "appointmentType": "HOME_VISIT",
    "referenceId": "REF-123",
    "lsGroupId": null,
    "lsProviderId": 42,
    "providerName": "Dr. John Doe",
    "meetingLink": null,
    "followUpDays": 14,
    "followUpUntil": "2025-06-15T05:30:00.000Z",
    "isFollowUp": false,
    "storeSuggestedTestIds": [
      "LSL100336",
      "LSL102387"
    ],
    "storeSuggestedPackageIds": [
      "LSP10538"
    ],
    "checkInUrl": null,
    "apiError": null
  },
  "uniqueId": "CUST001",
  "paymentLink": null,
  "paymentLinkExpiresAt": null,
  "previousAppointmentId": null,
  "discount": {
    "discountId": "DISC-1727430000000-K3F9QZ",
    "name": "10% off consultations",
    "couponCode": "CONSULT10",
    "baseAmount": 800,
    "discountAmount": 80,
    "payableAmount": 720
  }
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/appointment/bookAppointment' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "lsProviderId": 42,
    "lsProcedureId": 1,
    "appointmentType": "HOME_VISIT",
    "referenceId": "REF-123",
    "appointment": "2025-06-01T11:00:00+05:30",
    "notes": "Patient prefers a morning slot.",
    "uniqueId": "CUST001",
    "name": "Bob Smith",
    "email": "bobsmith@example.com",
    "mobile": "8047359194",
    "altContact": "8047359194",
    "dateOfBirth": "2000-01-01",
    "gender": "MALE",
    "unitFloorBuilding": "2nd Floor Tower 3",
    "address": "123 Main Road",
    "locality": "Gopalapur",
    "city": "Bangalore",
    "state": "Karnataka",
    "pincode": "560035",
    "meetingType": "VIDEO",
    "isPaymentRequired": false,
    "couponCode": "CONSULT10",
    "storeSuggestedTestIds": [
      "LSL100336",
      "LSL102387"
    ],
    "storeSuggestedPackageIds": [
      "LSP10538"
    ]
  }'

Cancel an appointment

Cancels an appointment for the store. This GET has side effects. An appointment can be cancelled up to a fixed notice period before its scheduled time -- 30 minutes by default. Inside that period, and for an appointment the patient did not attend, cancellation is refused and the caller is directed to support. An on-demand consult can be cancelled at any time, and an appointment whose provider never joined stays cancellable after its scheduled time. An online appointment whose consultation has already taken place cannot be cancelled, even while it awaits the provider's prescription or diet chart. If your account is set up to run its own appointment operations, appointments of the types you manage are not held to the notice period at all and can be cancelled at any time, including after their scheduled time has passed. An appointment that is already cancelled or already completed, or whose online consultation has already taken place, stays closed either way. Ask your account manager to enable this and to choose which appointment types it covers. A cancellation can occasionally fail temporarily. The appointment is then not reported as cancelled, and repeating the call is safe.

Query parameters

appointmentIdstringRequired
reasonstringOptional

Responses

200

Appointment cancelled

{
statusstring
appointmentobject
{
appointmentIdstring
appointmentStatusstring
}
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "appointment": {
    "appointmentId": "789",
    "appointmentStatus": "CANCELED"
  }
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/cancelAppointment?appointmentId=<value>&reason=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Delete all appointment documents

Currently disabled - always responds 501 Not Implemented.

Responses

200

Success

400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
501

Endpoint currently disabled

Request example

Request example (cURL)
curl -X DELETE 'https://integration.labstack.in/api/v1.0/appointment/deleteAllDocuments' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Delete an appointment document

Currently disabled - always responds 501 Not Implemented.

Responses

200

Success

400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
501

Endpoint currently disabled

Request example

Request example (cURL)
curl -X DELETE 'https://integration.labstack.in/api/v1.0/appointment/deleteDocument' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Raise an appointment escalation

Creates a store escalation tied to an appointment.

Request bodyRequired

{
appointmentIdintegerRequired
complaintstringRequired
severitystringRequired
Enum:LOWMEDIUMHIGHCRITICAL
descriptionstringOptional
notesstringOptional
}

Responses

200

Escalation created

{
statusstring
escalationobject
{
idinteger
complaintstring
statusstring
severitystring
}
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
500

Failed to create escalation

Sample response
{
  "status": "success",
  "escalation": {
    "id": 532,
    "complaint": "Provider did not join the call",
    "status": "PENDING",
    "severity": "HIGH"
  }
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/appointment/escalation' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appointmentId": 789,
    "complaint": "Provider did not join the call",
    "severity": "HIGH",
    "description": "The doctor was a no-show for the scheduled online consult.",
    "notes": "Customer waited 15 minutes before leaving."
  }'

Get appointment details

Returns full detail for one appointment including patient, provider, documents (as download links), and parsed prescription. checkInUrl is the patient's clinic check-in link, as bookAppointment returns it, while the appointment is open; null when the visit is not offered check-in. When the patient checks in, appointmentStatus becomes CHECKED_IN and customerArrivalTime is set.

Query parameters

appointmentIdstringRequired

Responses

200

Appointment details

{
statusstring
appointmentDetailsobject
{
appointmentIdstring
appointmentStatusstring
appointmentTypestring
Enum:ONLINECENTER_VISITHOME_VISIT
providerNamestring
referenceIdstring | null

Same value given when booking; null if none

lsProviderIdinteger
appointmentstring

ISO 8601 date-time

providerUnitFloorBuildingstring | null
providerAddressstring
providerLocalitystring | null
providerCitystring
providerStatestring
providerLatitudenumber
providerLongitudenumber
uniqueIdstring
namestring
dateOfBirthstring | null

YYYY-MM-DD

ageinteger | null
genderstring | null
Enum:MALEFEMALEOTHERS
mobilestring
altContactstring | null
unitFloorBuildingstring | null
addressstring
localitystring | null
citystring
statestring
pincodestring
customerArrivalTimestring | null

UTC; may be null

providerArrivalTimestring | null

UTC; may be null

consultStartTimestring | null

UTC; may be null

consultEndTimestring | null

When the consultation ended, UTC. Set as soon as the provider ends the consultation; otherwise filled in after the scheduled end, once the meeting can no longer be joined. Null until then.

checkInUrlstring | null

The patient's clinic check-in link while the appointment is open; null when the visit is not offered check-in

documentsarray<object>
{
typestring
Enum:PRESCRIPTIONPRIOR_PRESCRIPTIONREFERRALOTHER

PRESCRIPTION is the prescription the provider issued; PRIOR_PRESCRIPTION is one the patient already had

mimestring
linkstring

Download link

}[]
prescriptionobject | null

Null until the prescription is filled in

{
chiefComplaintsstring
doctorNotesstring
followUpAdvicestring
labTestsarray<object>
{
testIdstring
typestring
Enum:TESTPACKAGE
namestring
instructionsstring
}[]
medicationarray<object>
{
drugIdinteger | null

Null if custom

namestring
dosagestring
frequencystring
durationstring
additionalInstructionsstring
}[]
}
isFollowUpboolean
previousAppointmentIdinteger | null
followUpUntilstring | null
}
followUpDaysinteger | null

Free follow-up window (days); null if not configured

followupUntilstring | null

Deadline until which a follow-up is valid; null if not available

}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "appointmentDetails": {
    "appointmentId": "434585",
    "appointmentStatus": "PENDING",
    "appointmentType": "HOME_VISIT",
    "providerName": "Dr. John Doe",
    "referenceId": "123",
    "lsProviderId": 22,
    "appointment": "2024-12-23T18:25:43.511Z",
    "providerUnitFloorBuilding": "4th Floor Building A",
    "providerAddress": "1234 Clinic Road",
    "providerLocality": null,
    "providerCity": "Bangalore",
    "providerState": "Karnataka",
    "providerLatitude": 13.045163,
    "providerLongitude": 77.56,
    "uniqueId": "CUST001",
    "name": "Bob Smith",
    "dateOfBirth": "2000-01-01",
    "age": 24,
    "gender": "MALE",
    "mobile": "8047359194",
    "altContact": "8047359194",
    "unitFloorBuilding": "2nd Floor Tower 3",
    "address": "123 Main Road",
    "locality": "Gopalapur",
    "city": "Bangalore",
    "state": "Karnataka",
    "pincode": "560035",
    "customerArrivalTime": "2024-12-23T08:05:42.511Z",
    "providerArrivalTime": "2024-12-23T08:02:21.759Z",
    "consultStartTime": "2024-12-23T08:05:42.511Z",
    "consultEndTime": null,
    "checkInUrl": null,
    "documents": [
      {
        "type": "PRESCRIPTION",
        "mime": "application/pdf",
        "link": "https://integration.labstack.in/api/v1.0/appointment/getDocument?appointmentId=34&documentId=3"
      }
    ],
    "prescription": {
      "chiefComplaints": "stomach ache for 2 days",
      "doctorNotes": "Need follow up in 7 days",
      "followUpAdvice": "",
      "labTests": [],
      "medication": []
    },
    "isFollowUp": false,
    "previousAppointmentId": null,
    "followUpUntil": "2026-08-04T03:30:00.000Z"
  },
  "followUpDays": 7,
  "followupUntil": "2026-08-04T03:30:00.000Z"
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getAppointmentDetails?appointmentId=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List appointments

Paginated list of the store's appointments with optional date and email filters. (updatedSince is accepted but currently not applied.)

Query parameters

startDatestring · dateOptional
endDatestring · dateOptional
updatedSincestring · date-timeOptional
perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional
emailstringOptional

Responses

200

Appointment list

{
statusstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
appointmentsarray<object>
{
appointmentIdstring
appointmentStatusstring
appointmentTypestring
Enum:ONLINECENTER_VISITHOME_VISIT
referenceIdstring | null
lsGroupIdinteger | null
groupNamestring | null
lsProviderIdinteger
providerNamestring
appointmentDatestring

ISO 8601 date-time

specialitystring | null
subSpecialitystring | null
isFollowUpboolean
previousAppointmentIdinteger | null
followUpUntilstring | null
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 2,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "appointments": [
    {
      "appointmentId": "47585",
      "appointmentStatus": "CREATED",
      "appointmentType": "CENTER_VISIT",
      "referenceId": "213",
      "lsGroupId": 1,
      "groupName": "Top Doctors",
      "lsProviderId": 12,
      "providerName": "Dr. John Doe",
      "appointmentDate": "2023-12-23T18:25:43.511Z",
      "speciality": "blood",
      "subSpeciality": null,
      "isFollowUp": false,
      "previousAppointmentId": null,
      "followUpUntil": null
    },
    {
      "appointmentId": "434585",
      "appointmentStatus": "PENDING",
      "appointmentType": "HOME_VISIT",
      "referenceId": null,
      "lsGroupId": null,
      "groupName": null,
      "lsProviderId": 22,
      "providerName": "Dr. Jane Smith",
      "appointmentDate": "2024-12-23T18:25:43.511Z",
      "speciality": null,
      "subSpeciality": null,
      "isFollowUp": true,
      "previousAppointmentId": 42537,
      "followUpUntil": null
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getAppointments?startDate=&endDate=&updatedSince=&perPage=&page=&email=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Download an appointment document

Streams the raw document file (ownership-checked).

Query parameters

documentIdstringRequired

Responses

200

The document file

400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getDocument?documentId=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Get appointment escalation details

Returns the full record of one escalation raised on one of the store's appointments: the complaint, its description and notes, current status and severity, the patient, provider and appointment it concerns, and links to any attached images.

Query parameters

escalationIdintegerRequired

Responses

200

Escalation details

{
statusstring
escalationDetailsobject
{
escalationIdinteger
complaintstring

What the escalation is about.

descriptionstring | null
notesstring | null
entityTypestring
Enum:APPOINTMENT

What the escalation is raised on. Always APPOINTMENT for this endpoint.

appointmentIdinteger
appointmentTypestring
Enum:ONLINECENTER_VISITHOME_VISIT
statusstring
Enum:PENDINGIN_PROGRESSRESOLVEDDISMISSED
severitystring
Enum:LOWMEDIUMHIGHCRITICAL
userNamestring | null

Name of the patient the appointment is for.

uniqueIdstring | null

The patient's unique id as supplied by the store.

providerIdinteger | null
providerNamestring | null
createdAtstring · date-time
updatedAtstring · date-time
imagesarray<object>

Images attached to the escalation, oldest first. ISSUE images were attached when the escalation was raised; RESOLUTION images were added while resolving it. Fetch each one from its link with the same ls-api-key header.

{
typestring
Enum:ISSUERESOLUTION
idinteger
linkstring

URL of getEscalationImage for this image.

}[]
}
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
404

No escalation with this id exists on the store's appointments

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "escalationDetails": {
    "escalationId": 532,
    "complaint": "Provider did not join the call",
    "description": "The doctor was a no-show for the scheduled online consult.",
    "notes": "Customer waited 15 minutes before leaving.",
    "entityType": "APPOINTMENT",
    "appointmentId": 789,
    "appointmentType": "ONLINE",
    "status": "PENDING",
    "severity": "HIGH",
    "userName": "Priya Sharma",
    "uniqueId": "CUST-10442",
    "providerId": 45,
    "providerName": "Dr. Arjun Mehta",
    "createdAt": "2026-10-14T06:30:10.000Z",
    "updatedAt": "2026-10-14T06:30:10.000Z",
    "images": [
      {
        "type": "ISSUE",
        "id": 1204,
        "link": "https://integration.labstack.in/api/v1.0/appointment/getEscalationImage?appointmentId=789&type=ISSUE&imageId=1204"
      },
      {
        "type": "RESOLUTION",
        "id": 1219,
        "link": "https://integration.labstack.in/api/v1.0/appointment/getEscalationImage?appointmentId=789&type=RESOLUTION&imageId=1219"
      }
    ]
  }
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getEscalationDetails?escalationId=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Download an escalation image

Returns one image attached to an escalation on the store's appointment. ISSUE images were attached when the escalation was raised; RESOLUTION images were added while resolving it. Use the ready-made links in the images array of getEscalationDetails rather than building this URL yourself.

Query parameters

appointmentIdintegerRequired

Appointment the escalation was raised on.

typestringOptional
Enum:ISSUERESOLUTION

Optional check on the kind of image requested. When given, the image must be of this kind, otherwise the request fails with 400.

imageIdintegerRequired

Identifies the image. Taken from the images array of the escalation details.

Responses

200

The image file, with its own content type (for example image/jpeg or image/png).

400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
404

No image with this id exists on an escalation for this appointment

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getEscalationImage?appointmentId=<value>&type=&imageId=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List appointment escalations

Paginated list of escalations raised on the store's appointments, newest first. Returns the basic fields only; use getEscalationDetails for the full record of one escalation.

Query parameters

statusstringOptional
Enum:PENDINGIN_PROGRESSRESOLVEDDISMISSED

Only return escalations in this status.

appointmentIdintegerOptional

Only return escalations raised on this appointment.

perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional

Responses

200

Escalation list

{
statusstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
escalationsarray<object>
{
escalationIdinteger
complaintstring
appointmentIdinteger
statusstring
Enum:PENDINGIN_PROGRESSRESOLVEDDISMISSED
severitystring
Enum:LOWMEDIUMHIGHCRITICAL
createdAtstring · date-time
updatedAtstring · date-time
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 2,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "escalations": [
    {
      "escalationId": 533,
      "complaint": "Prescription not shared after consult",
      "appointmentId": 812,
      "status": "IN_PROGRESS",
      "severity": "MEDIUM",
      "createdAt": "2026-10-15T09:12:44.000Z",
      "updatedAt": "2026-10-15T11:40:02.000Z"
    },
    {
      "escalationId": 532,
      "complaint": "Provider did not join the call",
      "appointmentId": 789,
      "status": "PENDING",
      "severity": "HIGH",
      "createdAt": "2026-10-14T06:30:10.000Z",
      "updatedAt": "2026-10-14T06:30:10.000Z"
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getEscalations?status=&appointmentId=&perPage=&page=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Download prescription PDF

Renders and streams the appointment's prescription as a PDF.

Query parameters

appointmentIdstringRequired

Responses

200

Prescription PDF

400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
404

Prescription not available

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/getPrescriptionPdf?appointmentId=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Reschedule an appointment

Reschedules an appointment (or updates the requested time of a not-yet-assigned provider-group request) and refreshes the online meeting link. This GET has side effects. An appointment can be rescheduled up to a fixed notice period before its scheduled time -- 30 minutes by default. Inside that period, and for an appointment the patient did not attend, rescheduling is refused and the caller is directed to support. Three cases are not held to the notice period: a completed online appointment, which is how a follow-up is booked; an on-demand consult; and an appointment whose provider never joined. An online appointment whose consultation has already taken place but which is not yet completed - it is awaiting the provider's prescription or diet chart - cannot be rescheduled; once it is completed, rescheduling it books the follow-up. If your account is set up to run its own appointment operations, appointments of the types you manage are not held to the notice period at all. You can move one at any time, to any time -- including a time that has already passed -- and an appointment you cancelled can be moved back into an active slot. A completed appointment remains closed. Ask your account manager to enable this and to choose which appointment types it covers. A reschedule can occasionally fail temporarily. The appointment then keeps its current time, and repeating the call is safe.

Query parameters

appointmentIdstringRequired
appointmentTimestring · date-timeRequired

The new appointment time. Must be in the future, unless your account runs its own appointment operations for this appointment type.

Responses

200

Appointment rescheduled

{
statusstring
appointmentobject
{
appointmentIdinteger
appointmentTimestring · date-time | null
appointmentStatusstring
followUpDaysinteger | null

Free follow-up window (days) starting from the new appointment time; null if not configured or this appointment is itself a follow-up

followUpUntilstring | null
}
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "appointment": {
    "appointmentId": 789,
    "appointmentTime": "2025-06-02T11:00:00+05:30",
    "appointmentStatus": "RESCHEDULED",
    "followUpDays": null,
    "followUpUntil": null
  }
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/rescheduleAppointment?appointmentId=<value>&appointmentTime=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Submit appointment feedback

Records your customer's feedback on one of your appointments. feedbackType says which survey the feedback answers, and decides the rating scale and the survey answers the body must carry. Send any survey answers as top-level fields next to rating; do not wrap them in an object.

feedbackTypeWhat it ratesratingSurvey fieldsAccepted when
APPOINTMENT_COMPLETEThe customer's experience of the appointmentWhole number from 1 to 10NoneThe appointment is COMPLETED

A rating outside its type's range is rejected with 400. comments is optional.

An appointment holds one feedback per feedbackType: submitting the same feedbackType again for the same appointment replaces the earlier rating and comments. A low rating opens an escalation on the appointment for LabStack support to follow up.

Example APPOINTMENT_COMPLETE body:

json
{
  "appointmentId": 789,
  "feedbackType": "APPOINTMENT_COMPLETE",
  "rating": 8,
  "comments": "The doctor was thorough but the call started 10 minutes late."
}

Request bodyRequired

{
appointmentIdintegerRequired

Appointment id the feedback is about. Must be an appointment booked by your store.

feedbackTypestringRequired
Enum:APPOINTMENT_COMPLETE

Which survey this feedback answers. Decides the rating range and the survey fields required; see the table above.

ratingintegerRequired

Whole number from 1 to 10 for APPOINTMENT_COMPLETE.

commentsstringOptional

Optional. What the customer said, in their words. Up to 1000 characters.

}

Responses

200

Feedback recorded

{
statusstring
feedbackobject
{
appointmentIdinteger
feedbackTypestring
Enum:APPOINTMENT_COMPLETE
ratinginteger
maxRatinginteger

Highest rating on this feedbackType's scale: 10 for APPOINTMENT_COMPLETE.

commentsstring | null
}
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
404

Appointment not found for this store

{
statusstring
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
500

Feedback could not be saved

Sample response
{
  "status": "success",
  "feedback": {
    "appointmentId": 789,
    "feedbackType": "APPOINTMENT_COMPLETE",
    "rating": 8,
    "maxRating": 10,
    "comments": "The doctor was thorough but the call started 10 minutes late."
  }
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/appointment/submitFeedback' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appointmentId": 789,
    "feedbackType": "APPOINTMENT_COMPLETE",
    "rating": 8,
    "comments": "The doctor was thorough but the call started 10 minutes late."
  }'

Trigger a test appointment webhook

Sends one appointment webhook for an existing appointment to your Appointments Webhook URL, so you can test the endpoint that receives it. The appointment itself is not changed. If your store has no Appointments Webhook URL, nothing is sent and the call still answers success.

The webhook carries the appointment as it is now. Pass appointmentStatus to see the payload at another stage of the appointment, and event to choose what goes in events:

  • documents is empty for every status except COMPLETED and CANCELED. COMPLETED adds a sample PRESCRIPTION document when the appointment has none; its link is a placeholder and does not download.
  • event defaults to STATUS_CHANGED. Use CREATED to reproduce the webhook sent when an appointment is booked.

The payload is described under Webhook below. Webhooks sent for real changes to your appointments have the same shape.

Query parameters

appointmentIdstringRequired

Id of the appointment to send a webhook for. The appointment is not changed.

appointmentStatusstringOptional
Enum:PENDINGCREATEDCONFIRMEDRESCHEDULEDDELAYEDCHECKED_INCANCELEDCOMPLETEDPATIENT_NO_SHOWPROVIDER_NO_SHOW

Optional. Appointment status to put in the webhook instead of the appointment's current status.

eventstringOptional
Enum:CREATEDSTATUS_CHANGEDDOC_CHANGEDDATE_CHANGEDMEETING_EVENT

Optional. The event to put in events. Defaults to STATUS_CHANGED.

Responses

200

Webhook triggered

{
statusstring
messagestring
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
404

No appointment with this id belongs to your store

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "message": "Webhook successfully triggered"
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/appointment/testWebhook?appointmentId=434585&appointmentStatus=&event=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Webhook

POST<your Appointments Webhook URL>

Appointment webhook, sent to your Appointments Webhook URL when one of your appointments is booked or changes

Sent as a POST with a JSON body. Answer with any 2xx status; the response body is ignored.

Every webhook carries your store's webhook authentication header, a header name and value agreed with LabStack: check it to confirm the webhook came from LabStack. Contact us to set or change it. Its value does not change when your API keys are rotated or revoked.

events lists everything that changed in the update, so one webhook can carry several events:

EventSent when
CREATEDThe appointment was booked. Sent once, and never together with another event.
STATUS_CHANGEDappointmentStatus changed.
DATE_CHANGEDappointmentDate changed, for example when the appointment is rescheduled.
DOC_CHANGEDA document was added to, replaced in or removed from documents.
MEETING_EVENTOne of customerArrivalTime, providerArrivalTime, consultStartTime or consultEndTime was set or changed.
Headers
keystring

The webhook authentication header most stores receive, holding the webhook key agreed with LabStack for your store. If your store's authentication header has another name, that header is sent instead; if none is set up, webhooks carry no authentication header.

Payload
{
eventsarray<string>

What changed in this update. See the table above.

appointmentIdinteger

Appointment id, as returned by bookAppointment.

appointmentTypestring
Enum:ONLINECENTER_VISITHOME_VISIT
appointmentStatusstring
Enum:PENDINGCREATEDCONFIRMEDRESCHEDULEDDELAYEDCHECKED_INCANCELEDCOMPLETEDPATIENT_NO_SHOWPROVIDER_NO_SHOW
appointmentDatestring · date-time | null

Scheduled start, ISO 8601 in UTC; null while the appointment has no time.

referenceIdstring | null

The referenceId you gave when booking; null if none.

lsProviderIdinteger | null

Null until a provider is assigned. The same holds for every provider field below.

providerNamestring | null
providerGenderstring | null
Enum:MALEFEMALEOTHERS
providerUnitFloorBuildingstring | null
providerAddressstring | null
providerLocalitystring | null
providerCitystring | null
providerStatestring | null
providerPincodestring | null
providerLatitudenumber | null
providerLongitudenumber | null
uniqueIdstring | null

Your id for the patient.

namestring

Patient name.

emailstring | null
mobilestring | null
altNumberstring | null
genderstring | null
Enum:MALEFEMALEOTHERS
unitFloorBuildingstring | null
addressstring | null
localitystring | null
citystring | null
statestring | null
pincodestring | null
latitudenumber | null
longitudenumber | null
dateOfBirthstring | null

YYYY-MM-DD; null when not known.

ageinteger | null

Age in years; null when the date of birth is not known.

cancelReasonstring

Reason given when the appointment was canceled; empty otherwise.

customerArrivalTimestring · date-time | null

When the patient arrived, or joined the call for an ONLINE appointment. ISO 8601 in UTC; null until then.

providerArrivalTimestring · date-time | null

When the provider arrived, or joined the call for an ONLINE appointment. ISO 8601 in UTC; null until then.

consultStartTimestring · date-time | null

When the consultation started, ISO 8601 in UTC; null until then.

consultEndTimestring · date-time | null

When the consultation ended, ISO 8601 in UTC. Set as soon as the provider ends the consultation; otherwise filled in after the scheduled end, once the meeting can no longer be joined. Null until then.

documentsarray<object>

Documents attached to the appointment. Empty when there are none.

{
linkstring

Download link. Call it with your ls-api-key header.

typestring
Enum:PRESCRIPTIONPRIOR_PRESCRIPTIONREFERRALOTHER

PRESCRIPTION is the prescription the provider issued; PRIOR_PRESCRIPTION is one the patient already had.

mimestring

File type, such as application/pdf.

}[]
}
Sample payload
{
  "events": [
    "STATUS_CHANGED",
    "DOC_CHANGED"
  ],
  "appointmentId": 434585,
  "appointmentType": "CENTER_VISIT",
  "appointmentStatus": "COMPLETED",
  "appointmentDate": "2026-10-06T04:30:00.000Z",
  "referenceId": "123",
  "lsProviderId": 22,
  "providerName": "Dr. John Doe",
  "providerGender": "MALE",
  "providerUnitFloorBuilding": "4th Floor Building A",
  "providerAddress": "1234 Clinic Road",
  "providerLocality": "Indiranagar",
  "providerCity": "Bangalore",
  "providerState": "Karnataka",
  "providerPincode": "560038",
  "providerLatitude": 12.9784,
  "providerLongitude": 77.6408,
  "uniqueId": "CUST001",
  "name": "Asha Rao",
  "email": "asha.rao@example.com",
  "mobile": "8047359194",
  "altNumber": null,
  "gender": "FEMALE",
  "unitFloorBuilding": "2nd Floor Tower 3",
  "address": "123 Main Road",
  "locality": "Gopalapur",
  "city": "Bangalore",
  "state": "Karnataka",
  "pincode": "560035",
  "latitude": 12.9716,
  "longitude": 77.5946,
  "dateOfBirth": "1990-04-12",
  "age": 36,
  "cancelReason": "",
  "customerArrivalTime": "2026-10-06T04:22:10.000Z",
  "providerArrivalTime": "2026-10-06T04:15:42.000Z",
  "consultStartTime": "2026-10-06T04:31:05.000Z",
  "consultEndTime": "2026-10-06T04:48:30.000Z",
  "documents": [
    {
      "link": "https://console.labstack.in/api/v1.0/appointment/getDocument?documentId=3",
      "type": "PRESCRIPTION",
      "mime": "application/pdf"
    }
  ]
}

Upload appointment documents

Uploads 1-5 base64-encoded documents (pdf/jpg/jpeg/png, max 10 MB each) to an appointment. PRESCRIPTION is reserved for the prescription the provider issues and is rejected with 400 — use PRIOR_PRESCRIPTION for a prescription the patient already had.

Request bodyRequired

{
appointmentIdintegerRequired
documentsarray<object>Required
{
contentstringRequired

base64-encoded file

fileNamestringRequired
docTypestringRequired
Enum:PRIOR_PRESCRIPTIONREFERRALOTHER

PRIOR_PRESCRIPTION for a prescription the patient already had, REFERRAL for a referral letter, OTHER for anything else. PRESCRIPTION is provider-only and returns 400.

}[]
}

Responses

200

Documents uploaded

{
statusstring
appointmentIdinteger
uploadedCountinteger
documentsarray<object>
{
documentIdinteger
docTypestring
}[]
errorsarray<string>

present only on partial failure

}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "appointmentId": 789,
  "uploadedCount": 2,
  "documents": [
    {
      "documentId": 456,
      "docType": "PRIOR_PRESCRIPTION"
    },
    {
      "documentId": 457,
      "docType": "REFERRAL"
    }
  ]
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/appointment/uploadDocument' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appointmentId": 789,
    "documents": [
      {
        "content": "JVBERi0xLjQK...",
        "fileName": "prior-prescription.pdf",
        "docType": "PRIOR_PRESCRIPTION"
      }
    ]
  }'

Availability

Get appointment slots

Generates bookable slots per provider and provider group for a date, with distance filtering for CENTER_VISIT. Provide pincode OR latitude+longitude for non-ONLINE appointment types; provide speciality only when passing subSpeciality. For CENTER_VISIT the providers are returned nearest-first across pages.

Query parameters

providerTypestringRequired
appointmentTypestringRequired
Enum:ONLINECENTER_VISITHOME_VISIT
datestringRequired
specialitystringOptional
subSpecialitystringOptional
genderstringOptional
Enum:MALEFEMALE
procedureIdsstringOptional

Comma-separated list of procedure IDs

providerIdsstringOptional

Comma-separated list of provider IDs

perPageintegerOptional

Results per page. Defaults to 20, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional
latitudestringOptional
longitudestringOptional
pincodestringOptional
addressstringOptional
localitystringOptional
citystringOptional
statestringOptional
rangenumberOptional

Search radius in KM from the given location, applied to CENTER_VISIT only. Defaults to 10; values above 100 are rejected.

Responses

200

Success

{
statusstring
totalinteger

Providers available on the given date that match every filter (including range and provider leave). Paging through all pages returns exactly this many entries in slots.

pageinteger
perPageinteger
isLastPageboolean
slotsarray<object>
{
typestring
specialitiesarray<string>
subSpecialitiesarray<string>
providerNamestring
lsIdinteger
genderstring
Enum:MALEFEMALEOTHERS
timingarray<object>
{
startTimestring

HH:MM (24-hour)

endTimestring

HH:MM (24-hour)

procedureIdsarray<integer>
supportedAppointmentTypesarray<string>
}[]
unitFloorBuildingstring | null
addressstring
localitystring | null
citystring
statestring
pincodestring
latitudenumber
longitudenumber
distancenumber | null

Only for CENTER_VISIT appointment types

}[]
groupSlotsarray<object>
{
lsGroupIdinteger
procedureIdinteger
typestring
supportedAppointmentTypesarray<string>
specialitiesarray<string>
subSpecialitiesarray<string>
groupNamestring
timingarray<object>
{
startTimestring
endTimestring
}[]
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 2,
  "page": 1,
  "perPage": 20,
  "isLastPage": true,
  "pincode": "560035",
  "latitude": 13.045163,
  "longitude": 77.537758,
  "date": "2025-06-01",
  "slots": [
    {
      "type": "DOCTOR",
      "specialities": [],
      "subSpecialities": [],
      "providerName": "Dr. John Doe",
      "lsId": 347484,
      "gender": "MALE",
      "timing": [
        {
          "startTime": "08:15",
          "endTime": "08:45",
          "procedureIds": [
            1
          ],
          "supportedAppointmentTypes": [
            "ONLINE"
          ]
        },
        {
          "startTime": "09:15",
          "endTime": "09:45",
          "procedureIds": [
            1
          ],
          "supportedAppointmentTypes": [
            "ONLINE"
          ]
        },
        {
          "startTime": "14:00",
          "endTime": "14:30",
          "procedureIds": [
            1
          ],
          "supportedAppointmentTypes": [
            "ONLINE"
          ]
        }
      ],
      "unitFloorBuilding": "17/1",
      "address": "Happy Clinic - 2nd Cross",
      "locality": "Jaya Nagar",
      "city": "Bengaluru",
      "state": "Karnataka",
      "pincode": "560041",
      "latitude": 13.012313,
      "longitude": 76.3123189,
      "distance": 5.6
    },
    {
      "type": "DOCTOR",
      "specialities": [],
      "subSpecialities": [],
      "providerName": "Dr. Jane Smith",
      "lsId": 347485,
      "gender": "FEMALE",
      "timing": [
        {
          "startTime": "10:30",
          "endTime": "10:45",
          "procedureIds": [
            1,
            3
          ],
          "supportedAppointmentTypes": [
            "ONLINE",
            "CENTER_VISIT"
          ]
        },
        {
          "startTime": "13:00",
          "endTime": "13:30",
          "procedureIds": [
            1,
            3
          ],
          "supportedAppointmentTypes": [
            "ONLINE",
            "CENTER_VISIT"
          ]
        }
      ],
      "unitFloorBuilding": null,
      "address": "Healthy Clinic - 3rd Main Road",
      "locality": null,
      "city": "Bengaluru",
      "state": "Karnataka",
      "pincode": "560013",
      "latitude": 12.412917,
      "longitude": 76.5143189,
      "distance": 12.3
    }
  ],
  "groupSlots": [
    {
      "lsGroupId": 47645,
      "procedureId": 2,
      "type": "PHLEBOTOMIST",
      "supportedAppointmentTypes": [
        "CENTER_VISIT"
      ],
      "specialities": [],
      "subSpecialities": [],
      "groupName": "Bangalore Phlebos",
      "timing": [
        {
          "startTime": "08:15",
          "endTime": "08:45"
        },
        {
          "startTime": "09:15",
          "endTime": "09:45"
        },
        {
          "startTime": "14:00",
          "endTime": "14:30"
        }
      ]
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getAppointmentSlots?providerType=<value>&appointmentType=<value>&date=<value>&speciality=&subSpeciality=&gender=&procedureIds=&providerIds=&perPage=&page=&latitude=&longitude=&pincode=&address=&locality=&city=&state=&range=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List appointment discounts

Returns the store's appointment discounts that are live now. Each discount is limited by four whitelist/blacklist filters: provider types, specialities, procedures and providers. A WHITELIST filter applies the discount only to the listed items; a BLACKLIST filter applies it to everything except them, and an empty BLACKLIST applies it to everything. A booking qualifies only if it passes all four. For the speciality filter, a provider with several specialities qualifies unless every one of them is blacklisted. Discounts are applied by bookAppointment, which reports the discount a booking received; a discount with a COUPON_CODE condition applies only when that couponCode is sent.

Responses

200

Live appointment discounts

{
statusstring
discountsarray<object>
{
discountIdstring
namestring
descriptionstring | null
typestring
Enum:PERCENTAGEFIXED_AMOUNT
percentagenumber | null
maxAmountnumber | null

Upper limit (INR) on a PERCENTAGE discount.

amountnumber | null

Amount (INR) off for a FIXED_AMOUNT discount.

conditionsarray<object>

Optional conditions: COUPON_CODE, MIN_CART_VALUE, MAX_CART_VALUE, CART_VALUE_BETWEEN. Cart values are compared with the configured cost of the procedure being booked.

validFromstring | null
validUntilstring | null
maxUsageTotalnumber | null
maxUsagePerMobilenumber | null
providerTypesobject
{
modestring
Enum:WHITELISTBLACKLIST
itemsarray<object>
{
idinteger
namestring
}[]
}
specialitiesobject
{
modestring
Enum:WHITELISTBLACKLIST
itemsarray<object>
{
idinteger
namestring
}[]
}
proceduresobject

Item ids are lsProcedureId values.

{
modestring
Enum:WHITELISTBLACKLIST
itemsarray<object>
{
idinteger
namestring
}[]
}
providersobject

Item ids are lsProviderId values.

{
modestring
Enum:WHITELISTBLACKLIST
itemsarray<object>
{
idinteger
namestring
}[]
}
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "discounts": [
    {
      "discountId": "DISC-1727430000000-K3F9QZ",
      "name": "10% off consultations",
      "description": "For first-time patients",
      "type": "PERCENTAGE",
      "percentage": 10,
      "maxAmount": 200,
      "amount": null,
      "conditions": [
        {
          "type": "COUPON_CODE",
          "value": "CONSULT10"
        }
      ],
      "validFrom": "2026-09-01T00:00:00.000Z",
      "validUntil": null,
      "maxUsageTotal": 500,
      "maxUsagePerMobile": 1,
      "providerTypes": {
        "mode": "WHITELIST",
        "items": [
          {
            "id": 1,
            "name": "Doctor"
          }
        ]
      },
      "specialities": {
        "mode": "BLACKLIST",
        "items": [
          {
            "id": 12,
            "name": "Cardiology"
          }
        ]
      },
      "procedures": {
        "mode": "BLACKLIST",
        "items": []
      },
      "providers": {
        "mode": "BLACKLIST",
        "items": []
      }
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getDiscounts' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Get procedure details

Returns a procedure with the providers who offer it, the prices that apply to your store, and each provider's next available slot. Prices are specific to the API key used - where your store has its own agreed price for a provider's procedure, that is what is returned, and other stores may see different values for the same provider.

Query parameters

procedureIdintegerRequired
providerIdsstringOptional

Comma-separated list of provider IDs

appointmentTypesstringOptional

Comma-separated list of appointment types (ONLINE, CENTER_VISIT, HOME_VISIT)

perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional

Responses

200

Success

{
statusstring
lsProcedureIdinteger
namestring
preProcedureInstructionsstring
postProcedureInstructionsstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
providersarray<object>
{
lsIdinteger
namestring
retailPricenumber

Sale price for the procedure at your store

costnumber

Your store's cost for the procedure

pricingModelstring
Enum:FIXEDDISCOUNT
durationinteger

Slot duration in minutes

appointmentTypestring
Enum:ONLINECENTER_VISITHOME_VISIT
nextAvailableSlotstring

Next available slot start time (UTC). The same provider can appear multiple times with different appointment types.

}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "lsProcedureId": 1,
  "name": "Consultation",
  "preProcedureInstructions": "",
  "postProcedureInstructions": "",
  "total": 3,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "providers": [
    {
      "lsId": 7,
      "name": "Dr. Sameer Bhatia",
      "retailPrice": 800,
      "cost": 800,
      "pricingModel": "FIXED",
      "duration": 20,
      "appointmentType": "ONLINE",
      "nextAvailableSlot": "2026-07-21T13:50:00.000Z"
    },
    {
      "lsId": 4,
      "name": "Dr. Aisha Narayanan",
      "retailPrice": 600,
      "cost": 600,
      "pricingModel": "FIXED",
      "duration": 20,
      "appointmentType": "CENTER_VISIT",
      "nextAvailableSlot": "2026-07-23T13:50:00.000Z"
    },
    {
      "lsId": 19,
      "name": "Dr. Archana K",
      "retailPrice": 500,
      "cost": 500,
      "pricingModel": "FIXED",
      "duration": 20,
      "appointmentType": "HOME_VISIT",
      "nextAvailableSlot": "2026-07-22T13:50:00.000Z"
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getProcedure?procedureId=<value>&providerIds=&appointmentTypes=&perPage=&page=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List procedures

Paginated list of procedures offered in the store network.

Query parameters

perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional
providerTypestringOptional

Filter by provider type

Responses

200

Success

{
statusstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
proceduresarray<object>
{
lsProcedureIdinteger
namestring
preProcedureInstructionsstring
postProcedureInstructionsstring
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 2,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "procedures": [
    {
      "lsProcedureId": 1,
      "name": "Consultation",
      "preProcedureInstructions": "",
      "postProcedureInstructions": ""
    },
    {
      "lsProcedureId": 2,
      "name": "Injection",
      "preProcedureInstructions": "Do not consume alcohol 12 hours prior",
      "postProcedureInstructions": "Do not irritate the injected area"
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getProcedures?perPage=&page=&providerType=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Search providers

Searches network providers and provider groups with filtering; optional userUniqueId adds recent-appointment / follow-up data. Provide pincode OR latitude+longitude for non-ONLINE; provide speciality only with subSpeciality.

Pass scope=instantConsultGroup on its own to list the doctors who take your instant consults instead of searching. That form ignores every other parameter here, and is refused with 400 when instant consult is not set up for your account.

Pass procedureIds to price the results: each provider then carries procedures, its offers of those procedures for the appointmentType searched, with the prices that apply to your store and the next availability. This is the same pricing getProcedure returns, so one search finds, filters and prices providers.

Query parameters

scopestringOptional
Enum:instantConsultGroup

Set to instantConsultGroup to list the doctors who take your instant consults. Every other parameter is then ignored, including providerType and appointmentType, which are otherwise required.

providerTypestringRequired
appointmentTypestringRequired
Enum:ONLINECENTER_VISITHOME_VISIT
specialitystringOptional
subSpecialitystringOptional

Providers who record sub-specialities are matched on it. Providers who record none cannot be matched on it; they are listed after every provider that matches.

tagsstringOptional

Comma-separated list of tag names

procedureIdsstringOptional

Comma-separated list of procedure IDs. Lists the providers offering any of them for the appointmentType searched, and adds procedures to each provider with the price of each one it offers.

providerIdsstringOptional

Comma-separated list of provider IDs (the lsId of each provider). Restricts the search to these providers; provider groups are likewise reduced to their matching providers.

tagIdsstringOptional

Comma-separated list of tag IDs

categoryIdsstringOptional

Comma-separated list of tag category IDs

genderstringOptional
Enum:MALEFEMALE

Lists only providers of this gender. A provider whose gender is not recorded is left out.

latitudestringOptional
longitudestringOptional
pincodestringOptional
addressstringOptional
localitystringOptional
citystringOptional
statestringOptional
rangenumberOptional

Search radius in KM from the given location, applied to CENTER_VISIT only. Defaults to 10; values above 100 are rejected.

userUniqueIdstringOptional
perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional

Responses

200

Success

{
statusstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
latitudenumber | null
longitudenumber | null
providersarray<object>
{
lsIdinteger
typestring

Provider type (see appendix)

specialitiesarray<string>
subSpecialitiesarray<string>
tagsarray<object>
{
categorystring
namestring
}[]
supportedAppointmentTypesarray<string>
languagesKnownarray<string>
namestring
genderstring
Enum:MALEFEMALEOTHERS
yearsExperienceinteger | null
hasRecentAppointmentboolean

Only present when userUniqueId is supplied

followUpDaysinteger | null

Days of free follow-up offered after the appointment; null if not configured

followUpUntilstring | null

Only present when userUniqueId is supplied

recentAppointmentsarray<object>

Only present when userUniqueId is supplied

{
appointmentIdinteger
appointmentDatestring
appointmentTypestring
appointmentStatusstring
}[]
profileUrlstring | null
ratingnumber
totalRatingsinteger
unitFloorBuildingstring | null
addressstring
localitystring | null
citystring
statestring
pincodestring
latitudenumber
longitudenumber
distancenumber | null

Null if not a CENTER_VISIT appointment type

proceduresarray<object>

Only present when procedureIds is passed. The procedures among them the provider offers for the appointmentType searched, priced for your store; empty when it offers none of them.

{
lsProcedureIdinteger
namestring
retailPricenumber | null

Sale price for the procedure with this provider at your store. Where the provider is priced differently across their sessions, the lowest is shown.

costnumber | null

Your store's cost for the procedure with this provider

pricingModelstring
Enum:FIXEDDISCOUNT
durationinteger | null

Slot duration in minutes

payAtClinicboolean

True when the patient pays the clinic directly at the visit. Nothing is billed to your store for it, and retailPrice and cost are the clinic fee.

nextAvailableSlotstring | null

Start of the next bookable slot (UTC). Null when the search does not give a time; use nextAvailableDate, and getAppointmentSlots for the times.

nextAvailableDatestring | null

Day of the next bookable slot (YYYY-MM-DD, India time). Null when not known.

}[]
}[]
providerGroupsarray<object>

Provider groups servicing the location. specialities/subSpecialities/tags are the union across all providers in the group.

{
typestring
supportedAppointmentTypesarray<string>
specialitiesarray<string>
subSpecialitiesarray<string>
tagsarray<object>
groupNamestring
lsGroupIdinteger
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 2,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "latitude": 13.045163,
  "longitude": 77.537758,
  "providers": [
    {
      "lsId": 347484,
      "type": "DOCTOR",
      "specialities": [
        "General Physician"
      ],
      "subSpecialities": [],
      "tags": [
        {
          "category": "Symptom",
          "name": "Bleeding"
        },
        {
          "category": "Organ",
          "name": "Heart"
        }
      ],
      "supportedAppointmentTypes": [
        "ONLINE"
      ],
      "languagesKnown": [
        "English",
        "Hindi"
      ],
      "name": "Dr. John Doe",
      "gender": "MALE",
      "yearsExperience": 3,
      "hasRecentAppointment": true,
      "followUpDays": 14,
      "followUpUntil": "2025-06-15T05:30:00.000Z",
      "recentAppointments": [
        {
          "appointmentId": 10478,
          "appointmentDate": "2026-02-18T13:00:00.000Z",
          "appointmentType": "HOME_VISIT",
          "appointmentStatus": "CREATED"
        }
      ],
      "profileUrl": null,
      "rating": 4.3,
      "totalRatings": 28,
      "unitFloorBuilding": "Tower 3, floor 5",
      "address": "Main Street, 3rd Cross",
      "locality": "District Square",
      "city": "Bangalore",
      "state": "Karnataka",
      "pincode": "560013",
      "latitude": 13.045163,
      "longitude": 77.537758,
      "distance": null,
      "procedures": [
        {
          "lsProcedureId": 1,
          "name": "Consultation",
          "retailPrice": 600,
          "cost": 510,
          "pricingModel": "FIXED",
          "duration": 20,
          "payAtClinic": false,
          "nextAvailableSlot": "2026-11-18T09:00:00.000Z",
          "nextAvailableDate": "2026-11-18"
        }
      ]
    },
    {
      "lsId": 346484,
      "type": "DENTIST",
      "specialities": [],
      "subSpecialities": [],
      "tags": [
        {
          "category": "Symptom",
          "name": "Toothache"
        }
      ],
      "supportedAppointmentTypes": [
        "CENTER_VISIT"
      ],
      "languagesKnown": [
        "Hindi",
        "Kannada"
      ],
      "name": "Dr. Jane Smith",
      "gender": "FEMALE",
      "yearsExperience": null,
      "hasRecentAppointment": false,
      "followUpDays": 7,
      "followUpUntil": null,
      "recentAppointments": [],
      "profileUrl": "https://clinic.example/profile.png",
      "rating": 4.9,
      "totalRatings": 291,
      "unitFloorBuilding": null,
      "address": "4th Cross Rd, Centerway",
      "locality": null,
      "city": "Bangalore",
      "state": "Karnataka",
      "pincode": "560010",
      "latitude": 12.971599,
      "longitude": 77.594566,
      "distance": 4,
      "procedures": [
        {
          "lsProcedureId": 1,
          "name": "Consultation",
          "retailPrice": 550,
          "cost": 550,
          "pricingModel": "FIXED",
          "duration": 20,
          "payAtClinic": false,
          "nextAvailableSlot": null,
          "nextAvailableDate": "2026-11-19"
        }
      ]
    }
  ],
  "providerGroups": [
    {
      "type": "PHLEBOTOMIST",
      "supportedAppointmentTypes": [
        "CENTER_VISIT"
      ],
      "specialities": [],
      "subSpecialities": [],
      "tags": [],
      "groupName": "Bangalore Phlebos",
      "lsGroupId": 47645
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getProviders?scope=&providerType=<value>&appointmentType=<value>&speciality=&subSpeciality=&tags=&procedureIds=&providerIds=&tagIds=&categoryIds=&gender=&latitude=&longitude=&pincode=&address=&locality=&city=&state=&range=&userUniqueId=&perPage=&page=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List provider tag categories

Lists provider-tag categories in the store network with per-category tag counts.

Query parameters

perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional

Responses

200

Success

{
statusstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
categoriesarray<object>
{
categoryIdinteger
categoryNamestring
tagCountinteger
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 2,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "categories": [
    {
      "categoryId": 1,
      "categoryName": "Symptom",
      "tagCount": 2
    },
    {
      "categoryId": 2,
      "categoryName": "Organ",
      "tagCount": 2
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getProviderTagCategories?perPage=&page=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List provider tags

Lists provider tags with provider counts; optional categoryId filter.

Query parameters

perPageintegerOptional

Results per page. Defaults to 200, which is also the maximum; a larger value is rejected with a 400.

pageintegerOptional
categoryIdintegerOptional

Responses

200

Success

{
statusstring
totalinteger
perPageinteger
pageinteger
isLastPageboolean
tagsarray<object>
{
tagIdinteger
tagNamestring
categoryIdinteger
categoryNamestring
providerCountinteger
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "total": 4,
  "perPage": 200,
  "page": 1,
  "isLastPage": true,
  "tags": [
    {
      "tagId": 2,
      "tagName": "Cough",
      "categoryId": 1,
      "categoryName": "Symptom",
      "providerCount": 33
    },
    {
      "tagId": 1,
      "tagName": "Fever",
      "categoryId": 1,
      "categoryName": "Symptom",
      "providerCount": 42
    },
    {
      "tagId": 3,
      "tagName": "Head",
      "categoryId": 2,
      "categoryName": "Organ",
      "providerCount": 1
    },
    {
      "tagId": 4,
      "tagName": "Heart",
      "categoryId": 2,
      "categoryName": "Organ",
      "providerCount": 1
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getProviderTags?perPage=&page=&categoryId=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

List specialities

Lists specialities (with sub-specialities and merged tags) for a provider type.

Query parameters

providerTypestringRequired
tagsstringOptional

Comma-separated list of tag names

Responses

200

Success

{
statusstring
specialitiesarray<object>
{
namestring
providerCountinteger

Number of providers of this provider type mapped to the store for this speciality

subSpecialitiesarray<string>
tagsarray<object>
{
namestring
categorystring
}[]
}[]
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "specialities": [
    {
      "name": "Blood",
      "providerCount": 3,
      "subSpecialities": [
        "Transfusion",
        "Bone Marrow"
      ],
      "tags": [
        {
          "category": "Symptom",
          "name": "Bleeding"
        },
        {
          "category": "Symptom",
          "name": "Coughing Blood"
        },
        {
          "category": "Organ",
          "name": "Heart"
        }
      ]
    },
    {
      "name": "Neurology",
      "providerCount": 1,
      "subSpecialities": [
        "Epilepsy",
        "Behavioral Neurology",
        "Headache"
      ],
      "tags": []
    },
    {
      "name": "Muscular",
      "providerCount": 2,
      "subSpecialities": [],
      "tags": [
        {
          "category": "Organ",
          "name": "Brain"
        }
      ]
    }
  ]
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/availability/getSpecialities?providerType=<value>&tags=' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Consult

Cancel an instant consult request

Withdraws a request that is still waiting for a doctor, so it stops being offered. Use this when the patient gives up before a doctor accepts. Only a request still waiting can be withdrawn: once a doctor has accepted, or the request has expired or already been cancelled, the call is refused with 400 and the request is left as it is. A request created by another account is refused with 403.

Request bodyRequired

{
requestIdintegerRequired

The requestId returned by createInstant.

}

Responses

200

Request withdrawn

{
statusstring
requestIdinteger
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
403

The request belongs to another account

404

No such request

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "CANCELED",
  "requestId": 4821
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/consult/cancelInstant' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "requestId": 4821
  }'

Add an observer to a consult

Mints an extra meeting link for a consult a doctor has already accepted, so one of your own staff can join alongside the patient and the doctor. Each call returns a new, separate link, so request one per person joining and do not share a link between them. The consult must already have been accepted: a request still waiting for a doctor, expired or cancelled is refused with 400. A request created by another account is refused with 403.

Request bodyRequired

{
requestIdintegerRequired

The requestId returned by createInstant.

participantNamestringOptional

Shown to the others in the consult. Defaults to Observer.

}

Responses

201

Observer link created

{
statusstring
requestIdinteger
meetingLinkstring
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
403

The request belongs to another account

404

No such request

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "requestId": 4821,
  "meetingLink": "https://consult.labstack.in/meetings/0f8c2a1e?token=7a1c93be5d"
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/consult/createAdditionalParticipant' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "requestId": 4821,
    "participantName": "Care Desk"
  }'

Request an instant consult for a patient

Creates an instant consult request and offers it to the doctors available to your account. The response carries the requestId to poll with GET /api/v1.0/consult/getInstantStatus, and expiresAt — the moment the request stops being offered if no doctor has accepted it by then. Treat expiresAt as the deadline rather than assuming a fixed window. If the same patient already has a request still waiting for a doctor, that request is returned unchanged, with its original requestId and expiresAt, instead of a second one being started. The patient is identified by uniqueId; when you omit it, it is derived from the mobile number and name, and calling again with the same uniqueId updates that patient rather than creating another. Instant consult must be enabled for your account, and a call from an account without it is refused with 403; if it is enabled but no doctors are currently set up to take these, the call is refused with 409 rather than creating a request nobody would answer.

Request bodyRequired

{
namestringRequired
mobilestringRequired

Ten digits, not starting with 0.

genderstringOptional
Enum:MALEFEMALEOTHERS

Optional. Ignored if the patient already has a gender on record; change a recorded one with POST /api/admin/v1.0/user/updateUserDetails.

ageintegerOptional

Optional. Whole years, used when dateOfBirth is not given.

dateOfBirthstring · dateOptional

Optional. Cannot be in the future. Takes precedence over age. Ignored, like age, if the patient already has a date of birth on record; change a recorded one with POST /api/admin/v1.0/user/updateUserDetails.

uniqueIdstringOptional

Your own key for this patient. Derived from mobile and name when omitted.

specialityIdintegerOptional

The speciality the patient needs. The request is offered first to the doctors who hold it, and to the rest of your doctors shortly after, so naming one reaches the right doctor sooner without risking the request going unanswered. Omit it to reach everyone straight away.

providerTypeIdintegerOptional

Recorded on the request and returned with it. It does not change which doctors the request reaches.

notesstringOptional

Why the patient is calling, shown to the doctor who accepts.

clinicalContextobjectOptional

Optional snapshot shown to the doctor who accepts. Only the five keys below are kept, each trimmed to 500 characters; any other key is ignored.

{
chiefComplaintstringOptional
allergiesstringOptional
medicationsstringOptional
bloodGroupstringOptional
briefHistorystringOptional
}
}

Responses

201

Request created and being offered to doctors

{
statusstring

BROADCASTING while the request is waiting for a doctor to accept.

requestIdinteger
expiresAtstring · date-time
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
403

Instant consult is not enabled for this account

409

No doctors are currently set up to take instant consults for this account

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "BROADCASTING",
  "requestId": 4821,
  "expiresAt": "2026-09-27T10:32:00.000Z"
}

Request example

Request example (cURL)
curl -X POST 'https://integration.labstack.in/api/v1.0/consult/createInstant' \
  -H 'ls-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Asha Menon",
    "mobile": "9876543210",
    "gender": "FEMALE",
    "age": 34,
    "uniqueId": "PT-100294",
    "specialityId": 12,
    "notes": "Fever and sore throat since yesterday.",
    "clinicalContext": {
      "chiefComplaint": "Fever 101F, sore throat",
      "allergies": "Penicillin",
      "medications": "Paracetamol 500mg as needed",
      "bloodGroup": "O+",
      "briefHistory": "No chronic conditions."
    }
  }'

Check an instant consult request

Reports where an instant consult request has got to. Poll this after POST /api/v1.0/consult/createInstant until status leaves BROADCASTING. status is BROADCASTING while the request is still being offered, CLAIMED once a doctor has accepted it, EXPIRED once expiresAt has passed with no doctor having accepted, and CANCELED if you cancelled it. EXPIRED is reported as soon as the deadline has passed, whether or not you polled before it. Once a doctor has accepted, appointmentId and meetingLink are filled in; meetingLink is the patient's own link and can be opened directly, so send the patient straight to it. Both are null until then. A request created by another account is refused with 403.

Query parameters

requestIdstringRequired

The requestId returned by createInstant.

Responses

200

Current state of the request

{
statusstring
Enum:BROADCASTINGCLAIMEDEXPIREDCANCELED
requestIdinteger
expiresAtstring · date-time
appointmentIdinteger | null
meetingLinkstring | null
}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
403

The request belongs to another account

404

No such request

429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "CLAIMED",
  "requestId": 4821,
  "expiresAt": "2026-09-27T10:32:00.000Z",
  "appointmentId": 91245,
  "meetingLink": "https://consult.labstack.in/meetings/0f8c2a1e?token=0b9d41f6c2"
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/consult/getInstantStatus?requestId=<value>' \
  -H 'ls-api-key: <YOUR_API_KEY>'

Network

Get provider details

Returns a single provider profile (specialities, sub-specialities, tags, follow-up days) plus a computed next available slot (30-day forward search).

Query parameters

lsProviderIdintegerRequired
procedureIdintegerOptional

Responses

200

Success

{
statusstring
providerobject | null

Present when lsProviderId was given

{
typestring
specialitiesarray<string>
subspecialitiesarray<string>
tagsarray<object>
{
categorystring
namestring
}[]
supportedAppointmentTypesarray<string>
providerNamestring
genderstring
Enum:MALEFEMALEOTHERS
lsIdinteger
unitFloorBuildingstring | null
addressstring
localitystring | null
citystring
statestring
pincodestring
latitudenumber
longitudenumber
}
providerGroupobject | null

Present when lsGroupId was given instead

{
typestring
supportedAppointmentTypesarray<string>
specialitiesarray<string>
subspecialitiesarray<string>
groupNamestring
lsGroupIdinteger
}
ratingnumber | null

Average provider rating (1-5)

totalRatingsinteger

Total number of ratings received

followUpDaysinteger | null

Free follow-up window (days); null if not configured for this speciality

followupUntilstring | null

Deadline until which a follow-up is valid; null if not available

}
400

Bad request — missing or invalid parameters

{
statusstring
Enum:failure
errorstring
}
401

Unauthorized — API key missing, invalid, expired or revoked

{
statusstring
Enum:failure
errorstring
}
429

Too many failed authentication attempts from your address. Every request from that address is refused, whatever key it carries, until the number of seconds in the Retry-After header has passed.

{
statusstring
Enum:failure
errorstring
}
Sample response
{
  "status": "success",
  "provider": {
    "type": "DOCTOR",
    "specialities": [],
    "subspecialities": [],
    "tags": [
      {
        "category": "Symptom",
        "name": "Bleeding"
      },
      {
        "category": "Organ",
        "name": "Heart"
      }
    ],
    "supportedAppointmentTypes": [
      "ONLINE",
      "CENTER_VISIT"
    ],
    "providerName": "Dr. John Doe",
    "gender": "MALE",
    "lsId": 347484,
    "unitFloorBuilding": "Tower 3, floor 5",
    "address": "Main Street, 3rd Cross",
    "locality": "District Square",
    "city": "Bangalore",
    "state": "Karnataka",
    "pincode": "560013",
    "latitude": 13.045163,
    "longitude": 77.537758
  },
  "providerGroup": null,
  "rating": 4.3,
  "totalRatings": 28,
  "followUpDays": 14,
  "followupUntil": "2025-06-15T05:30:00.000Z"
}

Request example

Request example (cURL)
curl -X GET 'https://integration.labstack.in/api/v1.0/network/getProviderDetails?lsProviderId=<value>&procedureId=' \
  -H 'ls-api-key: <YOUR_API_KEY>'