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

The BCGW Dashboard integrates with Booqable through Stripe. Rental records are fetched from Stripe’s payment data and returned as Booqable rental objects. Client records can be looked up by email (which resolves a Stripe customer ID first) or directly by Stripe customer ID. Booqable client data is also synced automatically by the booqableSync scheduled function, which runs every 6 hours over a rolling 1-week window. All endpoints require a valid Firebase Auth ID token. Base URL: https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api

GET /booqable/rentals

Returns all Booqable rental records within a date range. Auth required: Yes

Query parameters

startDate
string
required
ISO 8601 start of the rental window (inclusive). Example: 2024-01-01T00:00:00Z.
endDate
string
required
ISO 8601 end of the rental window (inclusive). Example: 2024-02-01T00:00:00Z.

Example

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

Response

Returns a JSON array of Booqable rental objects retrieved via the Stripe integration.

Error codes

StatusReason
400startDate or endDate is missing, or failed to fetch rentals from Stripe
403Missing or invalid auth token

GET /booqable/rentals/customer

Returns all Booqable rental records for a specific customer, identified by email address or Stripe customer ID. Auth required: Yes At least one of email or stripeId must be provided. If both are provided, stripeId takes precedence and the email lookup is skipped. If an email is given but no matching Stripe customer exists, the endpoint returns an empty array rather than an error.

Query parameters

email
string
The customer’s email address. The server resolves this to a Stripe customer ID before fetching rentals. If no Stripe customer is found for this email, an empty array is returned.
stripeId
string
The customer’s Stripe customer ID. Takes precedence over email when both are provided.

Example

# Lookup by email
curl "https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api/booqable/rentals/customer?email=jane.doe%40example.com" \
  -H "Authorization: Bearer <id_token>"

# Lookup by Stripe customer ID
curl "https://us-east4-breastfeeding-center-gw.cloudfunctions.net/api/booqable/rentals/customer?stripeId=cus_abc123" \
  -H "Authorization: Bearer <id_token>"

Response

Returns a JSON array of Booqable rental objects for the specified customer. Returns an empty array [] if the customer has no rentals or if no Stripe customer was found for the given email.

Error codes

StatusReason
400Neither email nor stripeId was provided, or the Stripe/Booqable API call failed
403Missing or invalid auth token

Build docs developers (and LLMs) love