---
updatedAt: 2026-09-16T11:42:28.000Z
agentTools:
  projectIndex: https://developers.intandem.tech/llms.txt
---

# Get Appointments List

## Overview
Retrieves a paginated list of appointments for the business. Supports filtering by client, appointment state, and sorting.

## Booking note
Appointments are the scheduled items on the business calendar. To **create** an appointment (and to handle client lifecycle actions such as reschedule/cancel), use the Bookings endpoints (for example: `POST /platform/v1/scheduling/bookings`).

Available for **Staff and Application tokens**.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Scheduling",
    "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"
    }
  ],
  "paths": {
    "/platform/v1/scheduling/appointments": {
      "get": {
        "description": "## Overview\nRetrieves a paginated list of appointments for the business. Supports filtering by client, appointment state, and sorting.\n\n## Booking note\nAppointments are the scheduled items on the business calendar. To **create** an appointment (and to handle client lifecycle actions such as reschedule/cancel), use the Bookings endpoints (for example: `POST /platform/v1/scheduling/bookings`).\n\nAvailable for **Staff and Application tokens**.",
        "parameters": [
          {
            "description": "Business ID (optional)",
            "in": "query",
            "name": "business_id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Client ID Filter",
            "in": "query",
            "name": "client_id",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "State Filter - rejected/scheduled/done/cancelled/pending_reschedule/reschedule e.g state=done,rejected",
            "in": "query",
            "name": "state",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Multiple order by option - updated:DESC,start_at:ASC,created:DESC",
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page number of results. Default: 1",
            "in": "query",
            "name": "page",
            "required": false,
            "schema": {
              "type": "integer"
            }
          },
          {
            "description": "How many items to return per page. Default: 25. Max: 100",
            "in": "query",
            "name": "per_page",
            "required": false,
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "example": {
                  "data": {
                    "appointments": [
                      {
                        "approval_mode": null,
                        "business_uid": "104a5664c3663a8d",
                        "category_name": null,
                        "charge_type": "no_price",
                        "client_color_id": 0,
                        "client_first_name": "Deeanna",
                        "client_id": "xvl55kzldujkar76",
                        "client_last_name": "Rice",
                        "conversation_id": "c7g4pvubtj84j6b5",
                        "created_at": "2025-08-05T06:56:16.020Z",
                        "currency": null,
                        "duration": 30,
                        "end_time": "2025-08-11T06:30:00.000Z",
                        "id": "e7j16p8hrgacto4g",
                        "image_url": "",
                        "initiator": null,
                        "interaction_details": "consequuntur",
                        "interaction_type": "client_location",
                        "is_recurring": false,
                        "linked_booking_uid": null,
                        "no_show": false,
                        "notes": null,
                        "optional_times": [],
                        "payment_id": null,
                        "payment_status": null,
                        "price": "0.0",
                        "series_id": null,
                        "series_instance_count": null,
                        "service_id": "vxolrre9o6ob92ee",
                        "staff_display_name": "Britt Bogan",
                        "staff_id": "9a33fc142dbb67f3",
                        "staff_image": null,
                        "start_time": "2025-08-11T06:00:00.000Z",
                        "state": "scheduled",
                        "title": "Advanced didactic portal",
                        "type": "appointment",
                        "updated_at": "2025-08-05T06:56:16.020Z"
                      }
                    ],
                    "next_page": null
                  },
                  "status": "OK"
                }
              }
            }
          }
        },
        "summary": "Get Appointments List",
        "tags": [
          "Appointments"
        ],
        "x-amazon-apigateway-auth": {
          "type": "NONE"
        },
        "x-amazon-apigateway-integration": {
          "httpMethod": "GET",
          "responses": {
            "default": {
              "statusCode": "200"
            }
          },
          "type": "http_proxy",
          "uri": "https:///platform/v1/scheduling/appointments"
        },
        "x-auth-type": "Application & Application User",
        "security": [
          {
            "Bearer": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "Bearer": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Provide a valid bearer token in the Authorization header. Example: 'Authorization: Bearer {app_token}'"
      }
    }
  }
}
```