Luna Health API / API Reference / Get available appointment slots Get available appointment slots GET /availability
Lists the open appointment slots for one provider and service on a single day, using the provider's configured availability, existing appointments, blocked time, and your organization's booking cushion. Each slot lasts the service's duration. Times are ISO 8601 with the clinic's UTC offset. Pass a slot's start_time to POST /appointments to book it.
Code samples Node.js const fetch = require('node-fetch');
async function callApi() {
const apiKey = 'YOUR_API_KEY';
const staffId = 'your-staffId';
const serviceId = 'your-serviceId';
const date = 'your-date';
const locationId = 'your-locationId';
const queryString = new URLSearchParams({
staffId: staffId,
serviceId: serviceId,
date: date,
locationId: locationId
}).toString();
const url = `https://account.lunahealth.app/api/availability` + (queryString ? `?${queryString}` : '');
try {
const response = await fetch(url, {
method: 'GET',
headers: {
'Authorization': `Bearer ${apiKey}`,
'Content-Type': 'application/json'
}
});
if (!response.ok) {
throw new Error(`API error: ${response.status}`);
}
const data = await response.json();
console.log(data);
return data;
} catch (error) {
console.error('Error calling API:', error);
throw error;
}
}
callApi();Python import requests
def call_api():
api_key = 'YOUR_API_KEY'
url = 'https://account.lunahealth.app/api/availability'
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
params = {
'staffId': 'your-staffId',
'serviceId': 'your-serviceId',
'date': 'your-date',
'locationId': 'your-locationId'
}
try:
response = requests.get(
url,
headers=headers,
params=params
)
response.raise_for_status()
data = response.json()
print(data)
return data
except requests.exceptions.RequestException as e:
print(f'Error calling API: {e}')
raise
call_api()Parameters Name In Type Required Description staffIdquery string Yes ID of the provider (staff member) to check serviceIdquery string Yes ID of the service to book; sets the slot length datequery string Yes Calendar day as YYYY-MM-DD, in the provider's timezone locationIdquery string No —
Responses Status Description 200Successful response 400Invalid input data 401Authorization not provided 403Insufficient access 404Not found 500Internal server error
200 — Successful responseResponse fields Name Type Required Description datestring Yes — timezonestring Yes — slotsarray<object> Yes —
Example response {
"date": "string",
"timezone": "string",
"slots": [
{
"start_time": "string",
"end_time": "string"
}
]
}400 — Invalid input dataResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}401 — Authorization not providedResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}403 — Insufficient accessResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}404 — Not foundResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}500 — Internal server errorResponse fields Name Type Required Description messagestring Yes The error message codestring Yes The error code issuesarray<object> No An array of issues that were responsible for the error
Example response {
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}Open in interactive reference →
