vCita Availability Slots API
The Availability Slots API from vCita — 1 operation(s) for availability slots.
The Availability Slots API from vCita — 1 operation(s) for availability slots.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-availability-slots-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Scheduling Availability Slots API
description: Unified OpenAPI specification for scheduling domain
version: '3.0'
x-generated:
sourceFiles:
- legacy_v1_scheduling.json
- scheduling.json
- availability.json
- availability_slots.json
- resource_management.json
pathNormalizations:
- file: legacy_v1_scheduling.json
basePath: /platform/v1
transformations:
- original: /scheduling/appointments
normalized: /platform/v1/scheduling/appointments
basePath: /platform/v1
- original: /scheduling/appointments/{appointment_id}
normalized: /platform/v1/scheduling/appointments/{appointment_id}
basePath: /platform/v1
- original: /scheduling/bookings
normalized: /platform/v1/scheduling/bookings
basePath: /platform/v1
- original: /scheduling/bookings/cancel
normalized: /platform/v1/scheduling/bookings/cancel
basePath: /platform/v1
- original: /scheduling/bookings/{booking_uid}/update_rsvp_state
normalized: /platform/v1/scheduling/bookings/{booking_uid}/update_rsvp_state
basePath: /platform/v1
- original: /scheduling/event_attendances/{event_attendance_uid}
normalized: /platform/v1/scheduling/event_attendances/{event_attendance_uid}
basePath: /platform/v1
- original: /scheduling/event_instance/{event_instance_id}
normalized: /platform/v1/scheduling/event_instance/{event_instance_id}
basePath: /platform/v1
- original: /scheduling/scheduling_forms/get_form
normalized: /platform/v1/scheduling/scheduling_forms/get_form
basePath: /platform/v1
- original: /scheduling/waitlist
normalized: /platform/v1/scheduling/waitlist
basePath: /platform/v1
- original: /scheduling/waitlist/cancel
normalized: /platform/v1/scheduling/waitlist/cancel
basePath: /platform/v1
- original: /services
normalized: /platform/v1/services
basePath: /platform/v1
- original: /staff/availability
normalized: /platform/v1/staff/availability
basePath: /platform/v1
- file: scheduling.json
basePath: /business/scheduling
transformations:
- original: /v1/appointments
normalized: /business/scheduling/v1/appointments
basePath: /business/scheduling
- original: /v1/bookings
normalized: /business/scheduling/v1/bookings
basePath: /business/scheduling
- original: /v1/bookings/accept
normalized: /business/scheduling/v1/bookings/accept
basePath: /business/scheduling
- original: /v1/bookings/cancel
normalized: /business/scheduling/v1/bookings/cancel
basePath: /business/scheduling
- original: /v1/bookings/complete
normalized: /business/scheduling/v1/bookings/complete
basePath: /business/scheduling
- original: /v1/bookings/{booking_id}
normalized: /business/scheduling/v1/bookings/{booking_id}
basePath: /business/scheduling
- original: /v1/external_calendar_items/bulk_create
normalized: /business/scheduling/v1/external_calendar_items/bulk_create
basePath: /business/scheduling
- original: /v1/external_calendar_items/bulk_deactivate
normalized: /business/scheduling/v1/external_calendar_items/bulk_deactivate
basePath: /business/scheduling
- original: /v1/external_calendar_items/connect
normalized: /business/scheduling/v1/external_calendar_items/connect
basePath: /business/scheduling
- original: /v1/external_calendar_items/deactivate_external_calendar
normalized: /business/scheduling/v1/external_calendar_items/deactivate_external_calendar
basePath: /business/scheduling
- original: /v1/external_calendar_items/disable
normalized: /business/scheduling/v1/external_calendar_items/disable
basePath: /business/scheduling
- original: /v1/external_calendar_items/disconnect
normalized: /business/scheduling/v1/external_calendar_items/disconnect
basePath: /business/scheduling
- original: /v1/external_calendar_items/report_sync_status
normalized: /business/scheduling/v1/external_calendar_items/report_sync_status
basePath: /business/scheduling
- original: /v1/external_calendar_items/start_export
normalized: /business/scheduling/v1/external_calendar_items/start_export
basePath: /business/scheduling
- original: /v1/external_calendar_items/stop_import
normalized: /business/scheduling/v1/external_calendar_items/stop_import
basePath: /business/scheduling
- original: /v1/time_slots
normalized: /business/scheduling/v1/time_slots
basePath: /business/scheduling
- original: /v1/time_slots/{time_slot_uid}
normalized: /business/scheduling/v1/time_slots/{time_slot_uid}
basePath: /business/scheduling
pathConflicts: []
componentConflicts: []
totalPaths: 35
totalComponents: 4
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Availability Slots
paths:
/v3/scheduling/availability_slots:
get:
summary: Get all AvailabilitySlots
description: '## Overview
This endpoint returns available time slots for booking appointments. It considers staff schedules, resource availability, existing bookings, and business hours to compute open slots.
Available for **Staff, Directory, and Client tokens**'
tags:
- Availability Slots
parameters:
- name: start_time
in: query
required: true
description: Start time for availability search in ISO 8601 format (UTC). Must be a valid date-time string.
schema:
type: string
format: date-time
example: '2025-05-19T00:00:00.000Z'
- name: end_time
in: query
required: true
description: End time for availability search in ISO 8601 format (UTC). Must be after start_time. Recommended range is up to 31 days.
schema:
type: string
format: date-time
example: '2025-05-20T00:00:00.000Z'
- name: service_uid
in: query
required: false
description: Unique identifier of the service
schema:
type: string
- name: resource_type_uids
in: query
required: false
description: Comma-separated list of resource type UIDs. At least one of resource_type_uids, resource_uids, or staff_uids must be provided.
schema:
type: string
- name: resource_uids
in: query
required: false
description: Comma-separated list of resource UIDs. At least one of resource_type_uids, resource_uids, or staff_uids must be provided.
schema:
type: string
- name: staff_uids
in: query
required: false
description: Comma-separated list of staff UIDs. At least one of resource_type_uids, resource_uids, or staff_uids must be provided.
schema:
type: string
- name: slot_duration
in: query
required: false
description: Duration of each slot in minutes
schema:
type: integer
minimum: 1
- name: slot_interval
in: query
required: false
description: Interval between slots in minutes (if relevant)
schema:
type: integer
minimum: 1
- name: padding_before
in: query
required: false
description: Padding time before each slot in minutes (if relevant)
schema:
type: integer
minimum: 0
- name: padding_after
in: query
required: false
description: Padding time after each slot in minutes (if relevant)
schema:
type: integer
minimum: 0
- name: exclude_booking_uid
in: query
required: false
description: 'Unique identifier of a booking to exclude from busy slots calculation when determining availability. When provided, the specified booking is temporarily removed from the busy slots list before calculating available time slots. This is essential for rescheduling scenarios where you need to check if the original time slot would be available without the current booking, or for conflict detection when validating potential overlaps. Example: If booking ''abc123'' is scheduled from 2:00-3:00 PM and you want to reschedule it, passing exclude_booking_uid=abc123 will show 2:00-3:00 PM as available (assuming no other bookings conflict). If other bookings exist during that time, the slot remains busy.'
schema:
type: string
responses:
'200':
description: Availability slots retrieved successfully
content:
application/json:
schema:
allOf:
- type: object
properties:
success:
type: boolean
description: Indicates whether the API request was successful (true) or failed (false).
data:
type: object
description: 'The response payload. Present on successful responses (success: true).'
error:
type: string
description: Error message for simple error responses. Used in some legacy endpoints.
errors:
type: array
description: 'Array of error objects for detailed error responses. Present on error responses (success: false).'
items:
type: object
properties:
code:
type: string
description: Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found').
message:
type: string
description: Human-readable error message.
field:
type: string
description: The field that caused the error (for validation errors).
required:
- code
- message
required:
- success
description: Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string.
- properties:
data:
$ref: '#/components/schemas/AvailabilitySlotList'
'400':
description: Invalid request parameters - missing required parameters or invalid values
'401':
description: Unauthorized
'404':
description: Service or specified resources not found
'500':
description: Internal server error
security:
- Bearer: []
operationId: getV3SchedulingAvailabilitySlots
x-operation-id-source: derived
components:
schemas:
AvailabilitySlotList:
type: object
properties:
availability_slots:
description: List of AvailabilitySlots
type: array
items:
type: object
properties:
start:
type: string
format: date-time
description: Start date and time of the availability slot
example: '2025-05-19T10:00:00.000Z'
end:
type: string
format: date-time
description: End date and time of the availability slot
example: '2025-05-19T11:00:00.000Z'
available_entities:
type: array
description: List of available entities for this time slot
items:
type: object
properties:
entity_uid:
type: string
description: Unique identifier of the entity
example: staff-789
entity_type:
type: string
enum:
- staff
- resource
description: Type of the entity
group_entity_type:
type: string
enum:
- staff
- resource_type
description: Type of the group this entity belongs to
nullable: true
group_entity_uid:
type: string
description: Unique identifier of the group this entity belongs to (optional)
nullable: true
example: rt-456
required:
- entity_uid
- entity_type
required:
- start
- end
- available_entities
example:
start: '2025-05-19T10:00:00.000Z'
end: '2025-05-19T11:00:00.000Z'
available_entities:
- entity_uid: staff-789
entity_type: staff
group_entity_type: staff
- entity_uid: res-123
entity_type: resource
group_entity_type: resource_type
group_entity_uid: rt-456
- entity_uid: res-124
entity_type: resource
group_entity_type: resource_type
group_entity_uid: rt-456
description: Represents a time window and the entities available for booking within it.
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/delete_business-scheduling-v1-time-slots-time-slot-uid.md
- https://developers.intandem.tech/reference/delete_v3-scheduling-resource-types-uid.md
- https://developers.intandem.tech/reference/delete_v3-scheduling-resources-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-appointments-appointment-id.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-appointments.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-bookings.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-event-attendances-event-attendance-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-event-instance-event-instance-id.md
- https://developers.intandem.tech/reference/get_platform-v1-scheduling-scheduling-forms-get-form.md
- https://developers.intandem.tech/reference/get_platform-v1-services-1.md
- https://developers.intandem.tech/reference/get_platform-v1-staff-availability.md
- https://developers.intandem.tech/reference/get_v3-scheduling-availability-slots.md
- https://developers.intandem.tech/reference/get_v3-scheduling-resource-types-uid.md
- https://developers.intandem.tech/reference/get_v3-scheduling-resource-types.md
- https://developers.intandem.tech/reference/get_v3-scheduling-resources-uid.md
- https://developers.intandem.tech/reference/get_v3-scheduling-resources.md
- https://developers.intandem.tech/reference/post_business-scheduling-v1-appointments.md
- https://developers.intandem.tech/reference/post_business-scheduling-v1-bookings-accept.md
- https://developers.intandem.tech/reference/post_business-scheduling-v1-bookings-complete.md
- https://developers.intandem.tech/reference/post_business-scheduling-v1-bookings.md
- https://developers.intandem.tech/reference/post_business-scheduling-v1-time-slots.md
- https://developers.intandem.tech/reference/post_platform-v1-scheduling-bookings-cancel.md
- https://developers.intandem.tech/reference/post_platform-v1-scheduling-bookings.md
- https://developers.intandem.tech/reference/post_platform-v1-scheduling-waitlist.md
- https://developers.intandem.tech/reference/post_v3-scheduling-resource-types.md
- https://developers.intandem.tech/reference/post_v3-scheduling-resources.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-bookings-booking-id.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-bookings-cancel.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-bulk-create.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-bulk-deactivate.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-connect.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-deactivate-external-calendar.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-disable.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-disconnect.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-report-sync-status.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-start-export.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-external-calendar-items-stop-import.md
- https://developers.intandem.tech/reference/put_business-scheduling-v1-time-slots-time-slot-uid.md
- https://developers.intandem.tech/reference/put_platform-v1-scheduling-bookings-booking-uid-update-rsvp-state.md
- https://developers.intandem.tech/reference/put_platform-v1-scheduling-waitlist-cancel.md
- https://developers.intandem.tech/reference/put_v3-scheduling-resource-types-uid.md
- https://developers.intandem.tech/reference/put_v3-scheduling-resources-uid.md
- https://developers.intandem.tech:443/reference/delete_business-scheduling-v1-time-slots-time-slot-uid.md
- https://developers.intandem.tech:443/reference/delete_v3-scheduling-resource-types-uid.md
- https://developers.intandem.tech:443/reference/delete_v3-scheduling-resources-uid.md
- https://developers.intandem.tech:443/reference/get_platform-v1-scheduling-appointments-appointment-id.md
- https://developers.intandem.tech:443/reference/get_platform-v1-scheduling-appointments.md
- https://developers.intandem.tech:443/reference/get_platform-v1-scheduling-bookings.md
- https://developers.intandem.tech:443/reference/get_platform-v1-scheduling-event-attendances-event-attendance-uid.md
- https://developers.intandem.tech:443/reference/get_platform-v1-scheduling-event-instance-event-instance-id.md
- https://developers.intandem.tech:443/reference/get_platform-v1-scheduling-scheduling-forms-get-form.md
- https://developers.intandem.tech:443/reference/get_platform-v1-services-1.md
- https://developers.intandem.tech:443/reference/get_platform-v1-staff-availability.md
- https://developers.intandem.tech:443/reference/get_v3-scheduling-availability-slots.md
- https://developers.intandem.tech:443/reference/get_v3-scheduling-resource-types-uid.md
- https://developers.intandem.tech:443/reference/get_v3-scheduling-resource-types.md
- https://developers.intandem.tech:443/reference/get_v3-scheduling-resources-uid.md
- https://developers.intandem.tech:443/reference/get_v3-scheduling-resources.md
- https://developers.intandem.tech:443/reference/post_business-scheduling-v1-appointments.md
- https://developers.intandem.tech:443/reference/post_business-scheduling-v1-bookings-accept.md
- https://developers.intandem.tech:443/reference/post_business-scheduling-v1-bookings-complete.md
- https://developers.intandem.tech:443/reference/post_business-scheduling-v1-bookings.md
- https://developers.intandem.tech:443/reference/post_business-scheduling-v1-time-slots.md
- https://developers.intandem.tech:443/reference/post_platform-v1-scheduling-bookings-cancel.md
- https://developers.intandem.tech:443/reference/post_platform-v1-scheduling-bookings.md
- https://developers.intandem.tech:443/reference/post_platform-v1-scheduling-waitlist.md
- https://developers.intandem.tech:443/reference/post_v3-scheduling-resource-types.md
- https://developers.intandem.tech:443/reference/post_v3-scheduling-resources.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-bookings-booking-id.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-bookings-cancel.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-bulk-create.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-bulk-deactivate.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-connect.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-deactivate-external-calendar.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-disable.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-disconnect.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-report-sync-status.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-start-export.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-external-calendar-items-stop-import.md
- https://developers.intandem.tech:443/reference/put_business-scheduling-v1-time-slots-time-slot-uid.md
- https://developers.intandem.tech:443/reference/put_platform-v1-scheduling-bookings-booking-uid-update-rsvp-state.md
- https://developers.intandem.tech:443/reference/put_platform-v1-scheduling-waitlist-cancel.md
- https://developers.intandem.tech:443/reference/put_v3-scheduling-resource-types-uid.md
- https://developers.intandem.tech:443/reference/put_v3-scheduling-resources-uid.md
merge:
pages: 84
deduped: 128
conflicts_kept_first: 0