Skip to content
RocketLead Developers

Lookups

The Connect API exposes read-only lookups for everything in the resource planner — useful for bootstrapping an integration (see Workflows) or building a UI on top of RocketLead.

All endpoints below require read scope. Cache the responses — these don’t change often.

Differentiators

Section titled “Differentiators”
  • Calendars carry IANA tzdata — read this for any local-time math, don’t infer from the org or the user.
  • Resources have maxParallelBookings — capacity per slot (e.g., 8-seat group classes).
  • Appointment types have bookingLength AND searchLength — booking length is the actual duration, search length is the slot-search granularity (often equal, but search can be finer).
  • Mappings are many-to-many — both resource ↔ calendar and appointmentType ↔ resource are exposed as separate listing endpoints.
  • Blockers are returned as standalone entries — your UI overlays them on top of the resource grid (vacations, holidays, ad-hoc closures).

Calendars

Section titled “Calendars”
GET /connect/calendar/
GET /connect/calendar/{id}

Single calendar response:

Record<string, unknown>

Resources

Section titled “Resources”
GET /connect/resources/
GET /connect/resources/{id}

Single resource response:

Record<string, unknown>

Appointment types

Section titled “Appointment types”
GET /connect/appointment_types/
GET /connect/appointment_types/{id}

Single appointment-type response:

Record<string, unknown>

Resource slots

Section titled “Resource slots”
GET /connect/resource_slots/

The recurring time windows during which resources are bookable. Filterable by calendarId.

{
    calendarId: string;
}

Resource slot blockers

Section titled “Resource slot blockers”
GET /connect/resource_slot_blockers/

Vacation, holiday, and ad-hoc closure overlays on top of the recurring slot grid.

{
    calendarId: string;
}

Mappings

Section titled “Mappings”
GET /connect/resource_calendar_mappings/
GET /connect/appointment_type_resource_mappings/

Both support filtering by IDs (e.g., ?calendarId=<uuid>).

Section titled “Related”