Get available appointment slots
Returns available appointment time slots for a scheduling page or calendar. Requires calendarId (the scheduling page slug for HubSpot, or calendar ID for LeadConnector). Provider-specific parameters such as territoryId, resourceId, accountId, and policyId can be passed as additional query params and are forwarded verbatim to the provider (currently used by Salesforce).
Authorizations
Enter your API key with the Bearer prefix — e.g. Bearer sk_live_xxx (production) or Bearer sk_test_xxx (sandbox)
Headers
Identifier of the end user whose connected provider should be queried. This is the same endUserId you supplied when creating the connect token. Required on every CRM and accounting call.
"user-001"
Query Parameters
Provider slug identifying which connected provider to target (e.g. hubspot, pipedrive, zoho-crm, quickbooks-online, xero, zoho-books). Required — single-record operations always target a specific provider.
"hubspot"
Identifier of the scheduling page or calendar to query. The exact value depends on the provider:
- HubSpot — meeting scheduler slug (e.g.
parth-v1). - LeadConnector / GoHighLevel — calendar id.
- Salesforce — service appointment work type id (combine with
territoryId/resourceIdas needed).
"parth-v1"
Inclusive start of the availability window (ISO 8601). Slots starting before this timestamp are excluded.
"2026-04-15T00:00:00Z"
Exclusive end of the availability window (ISO 8601). Slots starting at or after this timestamp are excluded.
"2026-04-20T00:00:00Z"
IANA timezone (e.g. America/New_York) the provider should use when calculating availability windows and rendering slot start/end times. Defaults to the provider's configured timezone when omitted.
"America/New_York"
Response
Available appointment slots
Standard envelope returned by GET /crm/appointment/slots. data is a chronologically ordered list of slot windows within the requested startDate/endDate range.