vCita Resource API

The Resource API from vCita — 2 operation(s) for resource.

GitHub OpenAPI

Operations 5

GET /v3/scheduling/resources Get all Resources #
POST /v3/scheduling/resources Create a Resource #
GET /v3/scheduling/resources/{uid} Retrieve a Resource #
PUT /v3/scheduling/resources/{uid} Update a Resource #
DELETE /v3/scheduling/resources/{uid} Delete a Resource #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • 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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/vcita:vcita-resource-api"
All apis
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.

Get an API 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 Specification

vcita-resource-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Scheduling Resource 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: Resource
paths:
  /v3/scheduling/resources:
    get:
      summary: Get all Resources
      description: '## Overview

        Get all resources, with pagination and filtering by resource type or service.


        Available for **Staff Tokens**.'
      parameters:
      - name: page
        required: false
        in: query
        description: Page number of results
        schema:
          minimum: 1
          maximum: 10000
          default: 1
          type: number
      - name: per_page
        required: false
        in: query
        description: 'How many items to return per page. Max: 1000'
        schema:
          minimum: 1
          maximum: 1000
          default: 25
          type: number
      - description: 'Sort by fields. Example: sort=created_at:asc,updated_at:desc'
        name: sort
        required: false
        in: query
        schema:
          default: updated_at:desc
          type: string
      - name: resource_type_uid
        required: false
        in: query
        description: 'Filter by resource type UID(s). Accepts single value or array of values. Example: ?resource_type_uid=abc123 or ?resource_type_uid=abc123&resource_type_uid=def456'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      - name: service_uid
        required: false
        in: query
        description: Filter resources by service UID that requires their resource type
        schema:
          type: string
      - name: with_deleted
        required: false
        in: query
        description: Include deleted resources in the response
        schema:
          type: boolean
          default: false
      - name: uid
        required: false
        in: query
        description: 'Filter by resource UID(s). Accepts single value or array of values. Example: ?uid=abc123 or ?uid=abc123&uid=def456'
        schema:
          type: array
          items:
            type: string
        style: form
        explode: true
      responses:
        '200':
          description: ''
          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/ResourcesList'
        '302':
          description: OAuth redirect when no authentication token provided
        '401':
          description: Valid business context is required
        '408':
          description: Request exceeded timeout limit
      tags:
      - Resource
      security:
      - Bearer: []
      operationId: getV3SchedulingResources
      x-operation-id-source: derived
    post:
      summary: Create a Resource
      description: '## Overview

        Create a new resource Available for **Staff Tokens**.'
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the resource
                resource_type_uid:
                  type: string
                  description: The resource type this instance belongs to
              required:
              - name
              - resource_type_uid
      responses:
        '201':
          description: Resource created 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:
                      type: object
                      properties:
                        uid:
                          type: string
                          description: The entity's unique identifier
                          readOnly: true
                        created_at:
                          type: string
                          format: date-time
                          description: Creation date and time
                          readOnly: true
                        updated_at:
                          type: string
                          format: date-time
                          description: Last update date and time
                          readOnly: true
                        resource_type_uid:
                          type: string
                          description: The resource type this instance belongs to. Links to the ResourceType entity
                        name:
                          type: string
                          description: The name of the resource
                          example: Treatment Room 1
                        deleted_at:
                          type: string
                          format: date-time
                          description: Soft delete timestamp. Null for active resources
                          nullable: true
                          readOnly: true
                      required:
                      - name
                      - resource_type_uid
                      example:
                        uid: a4ca2054-3bb0-4788-8e9e-ee2442975e22
                        created_at: '2023-06-15T11:30:00Z'
                        updated_at: '2023-06-15T15:45:10Z'
                        resource_type_uid: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
                        name: Treatment Room 1
                        deleted_at: null
                      description: A schedulable resource instance (e.g., room, equipment) belonging to a resource type.
        '302':
          description: OAuth redirect when no authentication token provided
        '400':
          description: Invalid input data
        '401':
          description: Valid business context is required
        '403':
          description: 'Forbidden: Resources feature is not enabled or not authorized to create resources (requires account.settings.manage permission)'
        '408':
          description: Request exceeded timeout limit
        '422':
          description: Request data failed validation
      tags:
      - Resource
      security:
      - Bearer: []
      operationId: postV3SchedulingResources
      x-operation-id-source: derived
  /v3/scheduling/resources/{uid}:
    get:
      summary: Retrieve a Resource
      description: '## Overview

        Get a specific resource by UID.


        Available for **Staff, Directory, and Client tokens**'
      parameters:
      - name: uid
        required: true
        in: path
        description: Unique identifier of the Resource
        schema:
          type: string
        example: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
      - name: with_deleted
        required: false
        in: query
        description: Include deleted resources
        schema:
          type: boolean
      responses:
        '200':
          description: ''
          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:
                      type: object
                      properties:
                        uid:
                          type: string
                          description: The entity's unique identifier
                          readOnly: true
                        created_at:
                          type: string
                          format: date-time
                          description: Creation date and time
                          readOnly: true
                        updated_at:
                          type: string
                          format: date-time
                          description: Last update date and time
                          readOnly: true
                        resource_type_uid:
                          type: string
                          description: The resource type this instance belongs to. Links to the ResourceType entity
                        name:
                          type: string
                          description: The name of the resource
                          example: Treatment Room 1
                        deleted_at:
                          type: string
                          format: date-time
                          description: Soft delete timestamp. Null for active resources
                          nullable: true
                          readOnly: true
                      required:
                      - name
                      - resource_type_uid
                      example:
                        uid: a4ca2054-3bb0-4788-8e9e-ee2442975e22
                        created_at: '2023-06-15T11:30:00Z'
                        updated_at: '2023-06-15T15:45:10Z'
                        resource_type_uid: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
                        name: Treatment Room 1
                        deleted_at: null
                      description: A schedulable resource instance (e.g., room, equipment) belonging to a resource type.
        '302':
          description: OAuth redirect when no authentication token provided
        '401':
          description: Valid business context is required
        '403':
          description: Not authorized to access this resource
        '404':
          description: Resource not found
        '408':
          description: Request exceeded timeout limit
      tags:
      - Resource
      security:
      - Bearer: []
      operationId: getV3SchedulingResourcesByUid
      x-operation-id-source: derived
    put:
      summary: Update a Resource
      description: '## Overview

        Update a resource''s properties Available for **Staff Tokens**.'
      parameters:
      - name: uid
        required: true
        in: path
        description: Unique identifier of the Resource
        schema:
          type: string
        example: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the resource
                resource_type_uid:
                  type: string
                  description: The resource type this instance belongs to
      responses:
        '200':
          description: ''
          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:
                      type: object
                      properties:
                        uid:
                          type: string
                          description: The entity's unique identifier
                          readOnly: true
                        created_at:
                          type: string
                          format: date-time
                          description: Creation date and time
                          readOnly: true
                        updated_at:
                          type: string
                          format: date-time
                          description: Last update date and time
                          readOnly: true
                        resource_type_uid:
                          type: string
                          description: The resource type this instance belongs to. Links to the ResourceType entity
                        name:
                          type: string
                          description: The name of the resource
                          example: Treatment Room 1
                        deleted_at:
                          type: string
                          format: date-time
                          description: Soft delete timestamp. Null for active resources
                          nullable: true
                          readOnly: true
                      required:
                      - name
                      - resource_type_uid
                      example:
                        uid: a4ca2054-3bb0-4788-8e9e-ee2442975e22
                        created_at: '2023-06-15T11:30:00Z'
                        updated_at: '2023-06-15T15:45:10Z'
                        resource_type_uid: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
                        name: Treatment Room 1
                        deleted_at: null
                      description: A schedulable resource instance (e.g., room, equipment) belonging to a resource type.
        '302':
          description: OAuth redirect when no authentication token provided
        '400':
          description: Invalid input data
        '401':
          description: Valid business context is required
        '403':
          description: 'Forbidden: Resources feature is not enabled or not authorized to update this resource (requires account.settings.manage permission)'
        '404':
          description: Resource not found
        '408':
          description: Request exceeded timeout limit
        '422':
          description: Request data failed validation
      tags:
      - Resource
      security:
      - Bearer: []
      operationId: putV3SchedulingResourcesByUid
      x-operation-id-source: derived
    delete:
      summary: Delete a Resource
      description: '## Overview

        Soft-delete a resource Available for **Staff Tokens**.'
      parameters:
      - name: uid
        required: true
        in: path
        description: Unique identifier of the Resource
        schema:
          type: string
        example: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
      responses:
        '200':
          description: Resource deleted 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.
        '302':
          description: OAuth redirect when no authentication token provided
        '401':
          description: Valid business context is required
        '403':
          description: 'Forbidden: Resources feature is not enabled or not authorized to delete this resource (requires account.settings.manage permission)'
        '404':
          description: Resource not found
        '408':
          description: Request exceeded timeout limit
      tags:
      - Resource
      security:
      - Bearer: []
      operationId: deleteV3SchedulingResourcesByUid
      x-operation-id-source: derived
components:
  schemas:
    ResourcesList:
      type: object
      properties:
        resources:
          description: List of Resources
          type: array
          items:
            type: object
            properties:
              uid:
                type: string
                description: The entity's unique identifier
                readOnly: true
              created_at:
                type: string
                format: date-time
                description: Creation date and time
                readOnly: true
              updated_at:
                type: string
                format: date-time
                description: Last update date and time
                readOnly: true
              resource_type_uid:
                type: string
                description: The resource type this instance belongs to. Links to the ResourceType entity
              name:
                type: string
                description: The name of the resource
                example: Treatment Room 1
              deleted_at:
                type: string
                format: date-time
                description: Soft delete timestamp. Null for active resources
                nullable: true
                readOnly: true
            required:
            - name
            - resource_type_uid
            example:
              uid: a4ca2054-3bb0-4788-8e9e-ee2442975e22
              created_at: '2023-06-15T11:30:00Z'
              updated_at: '2023-06-15T15:45:10Z'
              resource_type_uid: 94ca2054-3bb0-4788-8e9e-ee2442975cdd
              name: Treatment Room 1
              deleted_at: null
            description: A schedulable resource instance (e.g., room, equipment) belonging to a resource type.
  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


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-resource-api-openapi.yml