Skip to main content
GET
Get available appointment slots

Authorizations

Authorization
string
header
required

Enter your API key with the Bearer prefix — e.g. Bearer sk_live_xxx (production) or Bearer sk_test_xxx (sandbox)

Headers

X-End-User-Id
string
required

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.

Example:

"user-001"

Query Parameters

provider
string
required

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.

Example:

"hubspot"

calendarId
string
required

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 / resourceId as needed).
Example:

"parth-v1"

startDate
string<date-time>
required

Inclusive start of the availability window (ISO 8601). Slots starting before this timestamp are excluded.

Example:

"2026-04-15T00:00:00Z"

endDate
string<date-time>
required

Exclusive end of the availability window (ISO 8601). Slots starting at or after this timestamp are excluded.

Example:

"2026-04-20T00:00:00Z"

timezone
string

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.

Example:

"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.

success
boolean
required

Always true for successful (2xx) responses.

Example:

true

statusCode
integer
required

HTTP status code mirrored inside the envelope.

Example:

200

message
string
required
Example:

"OK"

data
AppointmentSlot · object[]
required

Ordered list of available slots in the requested window.