Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/hack4impact-umd/breastfeeding-center-gw/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

These endpoints proxy appointment data from the Acuity Scheduling API. Data is fetched live from Acuity on each request and is not cached in Firestore. For real-time client sync from Acuity, see the webhook endpoint. All endpoints require a valid Firebase Auth ID token. Base URL: https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api

​
GET /acuity/appointments

Returns Acuity appointments within a date range, optionally filtered by class category. Auth required: Yes

​
Query parameters

​
startDate
string
required
ISO 8601 start of the query window (inclusive). Example: 2024-01-01T00:00:00Z.
​
endDate
string
required
ISO 8601 end of the query window (inclusive). Example: 2024-02-01T00:00:00Z.
​
classCategory
string
Filter results to a specific class category (case-insensitive). When omitted or set to "all classes", all categories are returned.

​
Example

# All appointments in January 2024
curl "https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api/acuity/appointments?startDate=2024-01-01T00:00:00Z&endDate=2024-02-01T00:00:00Z" \
  -H "Authorization: Bearer <id_token>"

# Filtered by class category
curl "https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api/acuity/appointments?startDate=2024-01-01T00:00:00Z&endDate=2024-02-01T00:00:00Z&classCategory=breastfeeding+basics" \
  -H "Authorization: Bearer <id_token>"

​
Response

Returns a JSON array of AcuityAppointment objects.
​
id
number
Unique Acuity appointment ID.
​
firstName
string
First name of the attendee.
​
lastName
string
Last name of the attendee.
​
email
string
Email address of the attendee.
​
instructor
string | null
Name of the calendar/instructor for the appointment. Maps to the Acuity calendar field.
​
class
string | null
Appointment type name. Maps to the Acuity type field.
​
classCategory
string | null
Category of the appointment type. Maps to the Acuity category field.
​
datetime
string
Appointment date and time in ISO 8601 format.
​
babyDueDatesISO
string[]
Array of baby due dates (ISO 8601) collected from intake form responses.

​
Error codes

StatusReason
400startDate or endDate is missing
403Missing or invalid auth token
500Failed to fetch appointments from the Acuity API

​
GET /acuity/appointments/client

Returns all Acuity appointments for a specific client identified by email address. Fetches live from the Acuity API. Auth required: Yes

​
Query parameters

​
email
string
required
The email address of the client whose appointments should be returned.

​
Example

curl "https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api/acuity/appointments/client?email=jane.doe%40example.com" \
  -H "Authorization: Bearer <id_token>"

​
Response

Returns a JSON array of AcuityAppointment objects for the specified client (same fields as GET /acuity/appointments).

​
Error codes

StatusReason
400email query parameter is missing
403Missing or invalid auth token

Build docs developers (and LLMs) love

Get started for freeTalk to us