Appointments

Get appointments

get

Retrieves appointments based on provided filters

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

fromDateone ofOptional

Date from which we need slots

Example: 2024-02-13

string · dateOptional

or

string · date-timeOptional

toDateone ofOptional

Date till which we need slots

Example: 2024-02-14

string · dateOptional

or

string · date-timeOptional

startDateTimeone ofOptional

Start date time of the appointment

Example: 2024-02-13

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofOptional

End date time of the appointment

Example: 2024-02-13

string · dateOptional

or

string · date-timeOptional

locationTypestring · enumOptional

Filter by location type

Example: HOMEPossible values:

includeHistorybooleanOptional

Get appointment history

Default: falseExample: true

includeProviderAvailabilitybooleanOptional

Get provider's availability

Default: falseExample: true

lastAppointmentanyOptional

The last appointment details

Default: {}

statusstringOptional

The status of the appointment

Default: pendingExample: confirmed

serviceProviderIdstringOptional

The ID of the service provider

Default: provider123Example: provider123

consumerIdstringOptional

The ID of the consumer

Default: consumer123Example: consumer123

isGroupbooleanOptional

Get Service Provider Group's Appointments

Default: falseExample: true

rolestring · enumOptional

Filter by Appintment Provider's role

Example: PROVIDERPossible values:

externalIdstringOptional

The external ID of the appointment

Example: 123

populationTagsnumber[]Optional

The population tags of the appointment

Default: []Example: [123]

Responses

200Success

application/json

400

Bad request - invalid input data

401

Unauthorized - invalid API key

500

Internal server error

get

/api/service-provider-scheduling/appointments

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/appointments HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

[
  {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  }
]

Book appointment

post

Books a new appointment

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

appointmentTypeIdstringOptional

appointmentInternalIdstringOptional

prioritystring · enumOptionalPossible values:

patientIdstringOptional

appointmentTypeTemplateIdstringOptional

startDateTimeone ofOptional

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofOptional

string · dateOptional

or

string · date-timeOptional

dateone ofOptional

string · dateOptional

or

string · date-timeOptional

startTimestringOptional

durationInMinutesnumberOptional

endTimestringOptional

notestringOptional

firstNamestringOptional

lastNamestringOptional

tokenstringOptional

emailstringOptional

externalIdstringOptional

timeZonestringOptional

attributesobjectOptional

cancellationReasonstringOptional

mobileNumberstringOptional

serviceProviderIdstringOptional

skipExternalSyncbooleanOptional

filterobjectOptional

overrideSlotsbooleanOptional

cancelbooleanOptional

bookbooleanOptional

updatedByanyOptional

actionIdnumberOptional

undoActionIdnumberOptional

undoActionsbooleanOptional

appointmentLocationAddressIdnumberOptional

parentResourceIdnumberOptional

referralIdnumberOptional

locationTypestringOptional

penaltyScorenumberOptional

penaltyReasonstringOptional

Responses

200Success

application/json

post

/api/service-provider-scheduling/appointments

HTTPcURLJavaScriptPython

POST /api/service-provider-scheduling/appointments HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1176

{
  "appointmentTypeId": "text",
  "appointmentInternalId": "text",
  "priority": "HIGH",
  "patientId": "text",
  "appointmentTypeTemplateId": "text",
  "startDateTime": "2025-12-15",
  "endDateTime": "2025-12-15",
  "date": "2025-12-15",
  "startTime": "text",
  "durationInMinutes": 1,
  "endTime": "text",
  "note": "text",
  "firstName": "text",
  "lastName": "text",
  "token": "text",
  "email": "text",
  "externalId": "text",
  "timeZone": "text",
  "attributes": {},
  "cancellationReason": "text",
  "mobileNumber": "text",
  "serviceProviderId": "text",
  "skipExternalSync": true,
  "relatedPatients": [],
  "relatedProviders": [],
  "resources": [],
  "filter": {},
  "overrideSlots": true,
  "cancel": true,
  "book": true,
  "updatedBy": null,
  "actionId": 1,
  "undoActionId": 1,
  "undoActions": true,
  "appointmentLocationAddressId": 1,
  "parentResourceId": 1,
  "referralId": 1,
  "locationType": "text",
  "penaltyScore": 1,
  "penaltyReason": "text",
  "referral": {
    "requesterAgent": "John Doe",
    "requesterAgentType": "Patient",
    "requesterOnBehalfOf": "ABC Hospital",
    "reason": "Patient needs further evaluation",
    "specialty": "Cardiology",
    "description": "Patient needs further evaluation",
    "source": "Zoho",
    "sourceId": "b302908451",
    "startDateTime": "2023-07-20T12:00:00Z",
    "expiryDateTime": "2023-07-20T12:00:00Z",
    "default": true
  }
}

200Success

{
  "id": "12345",
  "appointmentTypeId": "67890",
  "priority": "HIGH",
  "patientId": "54321",
  "consumerUuid": "uuid-1234",
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "1990-01-01T00:00:00Z",
  "gender": "Male",
  "email": "[email protected]",
  "patientTimeZone": "America/New_York",
  "date": "2023-10-01T00:00:00Z",
  "startTime": "10:00",
  "endTime": "11:00",
  "startDateTime": "2023-10-01T10:00:00Z",
  "endDateTime": "2023-10-01T11:00:00Z",
  "token": "token-1234",
  "timeZone": "America/New_York",
  "note": "Patient requested a follow-up",
  "locationType": "GOOGLE_MAPS",
  "locationInfo": "Room 101",
  "externalId": "ext-12345",
  "attributes": {
    "key": "value"
  },
  "status": "BOOKED",
  "cancellationReason": "Patient no-show",
  "customCancellationReason": "Patient requested reschedule",
  "serviceProviderAttributes": {
    "key": "value"
  },
  "skipExternalSync": true,
  "parentResourceId": true,
  "isProviderUnavailable": true,
  "parentResource": {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  },
  "resources": [],
  "appointmentType": {
    "id": "12345",
    "name": "Consultation",
    "priority": "HIGH",
    "description": "A brief consultation session",
    "durationInMinutes": 30,
    "appointmentTypeTemplateId": 1,
    "serviceProviderScheduleId": 2,
    "useDefaultAvailability": true,
    "overlappingSlots": true,
    "disabled": true,
    "externalId": "welkin-encounter-template",
    "schedulerSystemUserId": "user-123",
    "serviceProviderId": 1,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "color": "#FF5733",
    "locationType": "GOOGLE_MAPS",
    "userId": "user-456",
    "user": "[Circular Reference]",
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 1,
    "serviceProviderRole": "CLIENT_MANAGER",
    "bookingHorizon": 30,
    "attributes": {},
    "addressGroupId": 1,
    "addressGroup": "[Circular Reference]"
  },
  "participants": [],
  "relatedPatients": [],
  "relatedProviders": [],
  "appointmentWorkflow": {
    "id": "12345",
    "appointmentId": "67890",
    "workflowId": 1,
    "appointmentWorkflowTask": []
  },
  "updatedBy": {
    "key": "value"
  },
  "openTeleRoom": [],
  "patientMobileNumber": "[phone]",
  "schedulerAppointmentAction": [],
  "isAssigneeChanged": true,
  "appointmentLocationAddressId": 1,
  "appointmentLocationAddress": {
    "id": 12,
    "title": "Title",
    "line1": "10 Riverside",
    "line2": "Drive Mira Loma",
    "country": "United States",
    "state": "New Jersey",
    "district": "Passaic County",
    "city": "Woodland Park",
    "addressType": "PRIMARY",
    "zipCode": "123456",
    "latitude": 12.34,
    "longitude": 12.34,
    "deleted": true,
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01"
  },
  "referralId": 1,
  "referral": {
    "id": 1,
    "patientId": 123,
    "patient": {},
    "requesterAgent": "12345",
    "requesterAgentType": "Organization",
    "requesterOnBehalfOf": "12345",
    "reason": "12345",
    "specialty": "cardiology",
    "description": "text",
    "source": "Zoho",
    "sourceId": "Zoho",
    "status": "draft",
    "default": true,
    "startDateTime": "2023-07-11T10:30:00Z",
    "expiryDateTime": "2023-07-11T10:30:00Z",
    "schedulerAppointments": "[Circular Reference]",
    "createdAt": "2023-07-11T10:30:00Z",
    "updatedAt": "2023-07-11T10:30:00Z"
  },
  "populationTags": [],
  "invoice": {
    "id": 123,
    "amount": "100.00",
    "personId": 123,
    "organizationId": 456,
    "status": "paid",
    "currency": "USD",
    "description": "Invoice for services rendered",
    "appointmentId": 789,
    "externalId": "ext_inv_123",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-02T00:00:00.000Z",
    "invoiceToInvoiceItems": [],
    "url": "https://stripe.com/invoice/123"
  }
}

Reschedule appointment

put

Reschedules an existing appointment

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

rescheduledAppointmentTokenstringRequired

Responses

200Success

application/json

put

/api/service-provider-scheduling/appointments

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/appointments HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1232

{
  "rescheduledAppointmentToken": "text",
  "newAppointment": {
    "appointmentTypeId": "text",
    "appointmentInternalId": "text",
    "priority": "HIGH",
    "patientId": "text",
    "appointmentTypeTemplateId": "text",
    "startDateTime": "2025-12-15",
    "endDateTime": "2025-12-15",
    "date": "2025-12-15",
    "startTime": "text",
    "durationInMinutes": 1,
    "endTime": "text",
    "note": "text",
    "firstName": "text",
    "lastName": "text",
    "token": "text",
    "email": "text",
    "externalId": "text",
    "timeZone": "text",
    "attributes": {},
    "cancellationReason": "text",
    "mobileNumber": "text",
    "serviceProviderId": "text",
    "skipExternalSync": true,
    "relatedPatients": [],
    "relatedProviders": [],
    "resources": [],
    "filter": {},
    "overrideSlots": true,
    "cancel": true,
    "book": true,
    "updatedBy": null,
    "actionId": 1,
    "undoActionId": 1,
    "undoActions": true,
    "appointmentLocationAddressId": 1,
    "parentResourceId": 1,
    "referralId": 1,
    "locationType": "text",
    "penaltyScore": 1,
    "penaltyReason": "text",
    "referral": {
      "requesterAgent": "John Doe",
      "requesterAgentType": "Patient",
      "requesterOnBehalfOf": "ABC Hospital",
      "reason": "Patient needs further evaluation",
      "specialty": "Cardiology",
      "description": "Patient needs further evaluation",
      "source": "Zoho",
      "sourceId": "b302908451",
      "startDateTime": "2023-07-20T12:00:00Z",
      "expiryDateTime": "2023-07-20T12:00:00Z",
      "default": true
    }
  }
}

200Success

{
  "id": "12345",
  "appointmentTypeId": "67890",
  "priority": "HIGH",
  "patientId": "54321",
  "consumerUuid": "uuid-1234",
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "1990-01-01T00:00:00Z",
  "gender": "Male",
  "email": "[email protected]",
  "patientTimeZone": "America/New_York",
  "date": "2023-10-01T00:00:00Z",
  "startTime": "10:00",
  "endTime": "11:00",
  "startDateTime": "2023-10-01T10:00:00Z",
  "endDateTime": "2023-10-01T11:00:00Z",
  "token": "token-1234",
  "timeZone": "America/New_York",
  "note": "Patient requested a follow-up",
  "locationType": "GOOGLE_MAPS",
  "locationInfo": "Room 101",
  "externalId": "ext-12345",
  "attributes": {
    "key": "value"
  },
  "status": "BOOKED",
  "cancellationReason": "Patient no-show",
  "customCancellationReason": "Patient requested reschedule",
  "serviceProviderAttributes": {
    "key": "value"
  },
  "skipExternalSync": true,
  "parentResourceId": true,
  "isProviderUnavailable": true,
  "parentResource": {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  },
  "resources": [],
  "appointmentType": {
    "id": "12345",
    "name": "Consultation",
    "priority": "HIGH",
    "description": "A brief consultation session",
    "durationInMinutes": 30,
    "appointmentTypeTemplateId": 1,
    "serviceProviderScheduleId": 2,
    "useDefaultAvailability": true,
    "overlappingSlots": true,
    "disabled": true,
    "externalId": "welkin-encounter-template",
    "schedulerSystemUserId": "user-123",
    "serviceProviderId": 1,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "color": "#FF5733",
    "locationType": "GOOGLE_MAPS",
    "userId": "user-456",
    "user": "[Circular Reference]",
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 1,
    "serviceProviderRole": "CLIENT_MANAGER",
    "bookingHorizon": 30,
    "attributes": {},
    "addressGroupId": 1,
    "addressGroup": "[Circular Reference]"
  },
  "participants": [],
  "relatedPatients": [],
  "relatedProviders": [],
  "appointmentWorkflow": {
    "id": "12345",
    "appointmentId": "67890",
    "workflowId": 1,
    "appointmentWorkflowTask": []
  },
  "updatedBy": {
    "key": "value"
  },
  "openTeleRoom": [],
  "patientMobileNumber": "[phone]",
  "schedulerAppointmentAction": [],
  "isAssigneeChanged": true,
  "appointmentLocationAddressId": 1,
  "appointmentLocationAddress": {
    "id": 12,
    "title": "Title",
    "line1": "10 Riverside",
    "line2": "Drive Mira Loma",
    "country": "United States",
    "state": "New Jersey",
    "district": "Passaic County",
    "city": "Woodland Park",
    "addressType": "PRIMARY",
    "zipCode": "123456",
    "latitude": 12.34,
    "longitude": 12.34,
    "deleted": true,
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01"
  },
  "referralId": 1,
  "referral": {
    "id": 1,
    "patientId": 123,
    "patient": {},
    "requesterAgent": "12345",
    "requesterAgentType": "Organization",
    "requesterOnBehalfOf": "12345",
    "reason": "12345",
    "specialty": "cardiology",
    "description": "text",
    "source": "Zoho",
    "sourceId": "Zoho",
    "status": "draft",
    "default": true,
    "startDateTime": "2023-07-11T10:30:00Z",
    "expiryDateTime": "2023-07-11T10:30:00Z",
    "schedulerAppointments": "[Circular Reference]",
    "createdAt": "2023-07-11T10:30:00Z",
    "updatedAt": "2023-07-11T10:30:00Z"
  },
  "populationTags": [],
  "invoice": {
    "id": 123,
    "amount": "100.00",
    "personId": 123,
    "organizationId": 456,
    "status": "paid",
    "currency": "USD",
    "description": "Invoice for services rendered",
    "appointmentId": 789,
    "externalId": "ext_inv_123",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-02T00:00:00.000Z",
    "invoiceToInvoiceItems": [],
    "url": "https://stripe.com/invoice/123"
  }
}

Cancel appointment

delete

Cancels an existing appointment

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

anyOptional

Responses

200Success

application/json

delete

/api/service-provider-scheduling/appointments

HTTPcURLJavaScriptPython

DELETE /api/service-provider-scheduling/appointments HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*

200Success

{
  "id": "12345",
  "appointmentTypeId": "67890",
  "priority": "HIGH",
  "patientId": "54321",
  "consumerUuid": "uuid-1234",
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "1990-01-01T00:00:00Z",
  "gender": "Male",
  "email": "[email protected]",
  "patientTimeZone": "America/New_York",
  "date": "2023-10-01T00:00:00Z",
  "startTime": "10:00",
  "endTime": "11:00",
  "startDateTime": "2023-10-01T10:00:00Z",
  "endDateTime": "2023-10-01T11:00:00Z",
  "token": "token-1234",
  "timeZone": "America/New_York",
  "note": "Patient requested a follow-up",
  "locationType": "GOOGLE_MAPS",
  "locationInfo": "Room 101",
  "externalId": "ext-12345",
  "attributes": {
    "key": "value"
  },
  "status": "BOOKED",
  "cancellationReason": "Patient no-show",
  "customCancellationReason": "Patient requested reschedule",
  "serviceProviderAttributes": {
    "key": "value"
  },
  "skipExternalSync": true,
  "parentResourceId": true,
  "isProviderUnavailable": true,
  "parentResource": {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  },
  "resources": [],
  "appointmentType": {
    "id": "12345",
    "name": "Consultation",
    "priority": "HIGH",
    "description": "A brief consultation session",
    "durationInMinutes": 30,
    "appointmentTypeTemplateId": 1,
    "serviceProviderScheduleId": 2,
    "useDefaultAvailability": true,
    "overlappingSlots": true,
    "disabled": true,
    "externalId": "welkin-encounter-template",
    "schedulerSystemUserId": "user-123",
    "serviceProviderId": 1,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "color": "#FF5733",
    "locationType": "GOOGLE_MAPS",
    "userId": "user-456",
    "user": "[Circular Reference]",
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 1,
    "serviceProviderRole": "CLIENT_MANAGER",
    "bookingHorizon": 30,
    "attributes": {},
    "addressGroupId": 1,
    "addressGroup": "[Circular Reference]"
  },
  "participants": [],
  "relatedPatients": [],
  "relatedProviders": [],
  "appointmentWorkflow": {
    "id": "12345",
    "appointmentId": "67890",
    "workflowId": 1,
    "appointmentWorkflowTask": []
  },
  "updatedBy": {
    "key": "value"
  },
  "openTeleRoom": [],
  "patientMobileNumber": "[phone]",
  "schedulerAppointmentAction": [],
  "isAssigneeChanged": true,
  "appointmentLocationAddressId": 1,
  "appointmentLocationAddress": {
    "id": 12,
    "title": "Title",
    "line1": "10 Riverside",
    "line2": "Drive Mira Loma",
    "country": "United States",
    "state": "New Jersey",
    "district": "Passaic County",
    "city": "Woodland Park",
    "addressType": "PRIMARY",
    "zipCode": "123456",
    "latitude": 12.34,
    "longitude": 12.34,
    "deleted": true,
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01"
  },
  "referralId": 1,
  "referral": {
    "id": 1,
    "patientId": 123,
    "patient": {},
    "requesterAgent": "12345",
    "requesterAgentType": "Organization",
    "requesterOnBehalfOf": "12345",
    "reason": "12345",
    "specialty": "cardiology",
    "description": "text",
    "source": "Zoho",
    "sourceId": "Zoho",
    "status": "draft",
    "default": true,
    "startDateTime": "2023-07-11T10:30:00Z",
    "expiryDateTime": "2023-07-11T10:30:00Z",
    "schedulerAppointments": "[Circular Reference]",
    "createdAt": "2023-07-11T10:30:00Z",
    "updatedAt": "2023-07-11T10:30:00Z"
  },
  "populationTags": [],
  "invoice": {
    "id": 123,
    "amount": "100.00",
    "personId": 123,
    "organizationId": 456,
    "status": "paid",
    "currency": "USD",
    "description": "Invoice for services rendered",
    "appointmentId": 789,
    "externalId": "ext_inv_123",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-02T00:00:00.000Z",
    "invoiceToInvoiceItems": [],
    "url": "https://stripe.com/invoice/123"
  }
}

Get appointment by ID

get

Retrieves an appointment by its ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idstringRequiredPattern: [^\/#\?]+?

Query parameters

includeInvoicebooleanOptional

Responses

200Success

application/json

get

/api/service-provider-scheduling/appointments/{id}

HTTPcURLJavaScriptPython

GET /api/service-provider-scheduling/appointments/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "12345",
  "appointmentTypeId": "67890",
  "priority": "HIGH",
  "patientId": "54321",
  "consumerUuid": "uuid-1234",
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "1990-01-01T00:00:00Z",
  "gender": "Male",
  "email": "[email protected]",
  "patientTimeZone": "America/New_York",
  "date": "2023-10-01T00:00:00Z",
  "startTime": "10:00",
  "endTime": "11:00",
  "startDateTime": "2023-10-01T10:00:00Z",
  "endDateTime": "2023-10-01T11:00:00Z",
  "token": "token-1234",
  "timeZone": "America/New_York",
  "note": "Patient requested a follow-up",
  "locationType": "GOOGLE_MAPS",
  "locationInfo": "Room 101",
  "externalId": "ext-12345",
  "attributes": {
    "key": "value"
  },
  "status": "BOOKED",
  "cancellationReason": "Patient no-show",
  "customCancellationReason": "Patient requested reschedule",
  "serviceProviderAttributes": {
    "key": "value"
  },
  "skipExternalSync": true,
  "parentResourceId": true,
  "isProviderUnavailable": true,
  "parentResource": {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  },
  "resources": [],
  "appointmentType": {
    "id": "12345",
    "name": "Consultation",
    "priority": "HIGH",
    "description": "A brief consultation session",
    "durationInMinutes": 30,
    "appointmentTypeTemplateId": 1,
    "serviceProviderScheduleId": 2,
    "useDefaultAvailability": true,
    "overlappingSlots": true,
    "disabled": true,
    "externalId": "welkin-encounter-template",
    "schedulerSystemUserId": "user-123",
    "serviceProviderId": 1,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "color": "#FF5733",
    "locationType": "GOOGLE_MAPS",
    "userId": "user-456",
    "user": "[Circular Reference]",
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 1,
    "serviceProviderRole": "CLIENT_MANAGER",
    "bookingHorizon": 30,
    "attributes": {},
    "addressGroupId": 1,
    "addressGroup": "[Circular Reference]"
  },
  "participants": [],
  "relatedPatients": [],
  "relatedProviders": [],
  "appointmentWorkflow": {
    "id": "12345",
    "appointmentId": "67890",
    "workflowId": 1,
    "appointmentWorkflowTask": []
  },
  "updatedBy": {
    "key": "value"
  },
  "openTeleRoom": [],
  "patientMobileNumber": "[phone]",
  "schedulerAppointmentAction": [],
  "isAssigneeChanged": true,
  "appointmentLocationAddressId": 1,
  "appointmentLocationAddress": {
    "id": 12,
    "title": "Title",
    "line1": "10 Riverside",
    "line2": "Drive Mira Loma",
    "country": "United States",
    "state": "New Jersey",
    "district": "Passaic County",
    "city": "Woodland Park",
    "addressType": "PRIMARY",
    "zipCode": "123456",
    "latitude": 12.34,
    "longitude": 12.34,
    "deleted": true,
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01"
  },
  "referralId": 1,
  "referral": {
    "id": 1,
    "patientId": 123,
    "patient": {},
    "requesterAgent": "12345",
    "requesterAgentType": "Organization",
    "requesterOnBehalfOf": "12345",
    "reason": "12345",
    "specialty": "cardiology",
    "description": "text",
    "source": "Zoho",
    "sourceId": "Zoho",
    "status": "draft",
    "default": true,
    "startDateTime": "2023-07-11T10:30:00Z",
    "expiryDateTime": "2023-07-11T10:30:00Z",
    "schedulerAppointments": "[Circular Reference]",
    "createdAt": "2023-07-11T10:30:00Z",
    "updatedAt": "2023-07-11T10:30:00Z"
  },
  "populationTags": [],
  "invoice": {
    "id": 123,
    "amount": "100.00",
    "personId": 123,
    "organizationId": 456,
    "status": "paid",
    "currency": "USD",
    "description": "Invoice for services rendered",
    "appointmentId": 789,
    "externalId": "ext_inv_123",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-02T00:00:00.000Z",
    "invoiceToInvoiceItems": [],
    "url": "https://stripe.com/invoice/123"
  }
}

Update appointment

put

Updates an existing appointment

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

tokenstringRequiredPattern: [^\/#\?]+?

Body

application/json

appointmentTypeIdstringOptional

appointmentInternalIdstringOptional

prioritystring · enumOptionalPossible values:

patientIdstringOptional

appointmentTypeTemplateIdstringOptional

startDateTimeone ofOptional

string · dateOptional

or

string · date-timeOptional

endDateTimeone ofOptional

string · dateOptional

or

string · date-timeOptional

dateone ofOptional

string · dateOptional

or

string · date-timeOptional

startTimestringOptional

durationInMinutesnumberOptional

endTimestringOptional

notestringOptional

firstNamestringOptional

lastNamestringOptional

tokenstringOptional

emailstringOptional

externalIdstringOptional

timeZonestringOptional

attributesobjectOptional

cancellationReasonstringOptional

mobileNumberstringOptional

serviceProviderIdstringOptional

skipExternalSyncbooleanOptional

filterobjectOptional

overrideSlotsbooleanOptional

cancelbooleanOptional

bookbooleanOptional

updatedByanyOptional

actionIdnumberOptional

undoActionIdnumberOptional

undoActionsbooleanOptional

appointmentLocationAddressIdnumberOptional

parentResourceIdnumberOptional

referralIdnumberOptional

locationTypestringOptional

penaltyScorenumberOptional

penaltyReasonstringOptional

Responses

200Success

application/json

put

/api/service-provider-scheduling/appointments/{token}

HTTPcURLJavaScriptPython

PUT /api/service-provider-scheduling/appointments/{token} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1176

{
  "appointmentTypeId": "text",
  "appointmentInternalId": "text",
  "priority": "HIGH",
  "patientId": "text",
  "appointmentTypeTemplateId": "text",
  "startDateTime": "2025-12-15",
  "endDateTime": "2025-12-15",
  "date": "2025-12-15",
  "startTime": "text",
  "durationInMinutes": 1,
  "endTime": "text",
  "note": "text",
  "firstName": "text",
  "lastName": "text",
  "token": "text",
  "email": "text",
  "externalId": "text",
  "timeZone": "text",
  "attributes": {},
  "cancellationReason": "text",
  "mobileNumber": "text",
  "serviceProviderId": "text",
  "skipExternalSync": true,
  "relatedPatients": [],
  "relatedProviders": [],
  "resources": [],
  "filter": {},
  "overrideSlots": true,
  "cancel": true,
  "book": true,
  "updatedBy": null,
  "actionId": 1,
  "undoActionId": 1,
  "undoActions": true,
  "appointmentLocationAddressId": 1,
  "parentResourceId": 1,
  "referralId": 1,
  "locationType": "text",
  "penaltyScore": 1,
  "penaltyReason": "text",
  "referral": {
    "requesterAgent": "John Doe",
    "requesterAgentType": "Patient",
    "requesterOnBehalfOf": "ABC Hospital",
    "reason": "Patient needs further evaluation",
    "specialty": "Cardiology",
    "description": "Patient needs further evaluation",
    "source": "Zoho",
    "sourceId": "b302908451",
    "startDateTime": "2023-07-20T12:00:00Z",
    "expiryDateTime": "2023-07-20T12:00:00Z",
    "default": true
  }
}

200Success

{
  "id": "12345",
  "appointmentTypeId": "67890",
  "priority": "HIGH",
  "patientId": "54321",
  "consumerUuid": "uuid-1234",
  "firstName": "John",
  "lastName": "Doe",
  "birthDate": "1990-01-01T00:00:00Z",
  "gender": "Male",
  "email": "[email protected]",
  "patientTimeZone": "America/New_York",
  "date": "2023-10-01T00:00:00Z",
  "startTime": "10:00",
  "endTime": "11:00",
  "startDateTime": "2023-10-01T10:00:00Z",
  "endDateTime": "2023-10-01T11:00:00Z",
  "token": "token-1234",
  "timeZone": "America/New_York",
  "note": "Patient requested a follow-up",
  "locationType": "GOOGLE_MAPS",
  "locationInfo": "Room 101",
  "externalId": "ext-12345",
  "attributes": {
    "key": "value"
  },
  "status": "BOOKED",
  "cancellationReason": "Patient no-show",
  "customCancellationReason": "Patient requested reschedule",
  "serviceProviderAttributes": {
    "key": "value"
  },
  "skipExternalSync": true,
  "parentResourceId": true,
  "isProviderUnavailable": true,
  "parentResource": {
    "id": "12345",
    "appointmentTypeId": "67890",
    "priority": "HIGH",
    "patientId": "54321",
    "consumerUuid": "uuid-1234",
    "firstName": "John",
    "lastName": "Doe",
    "birthDate": "1990-01-01T00:00:00Z",
    "gender": "Male",
    "email": "[email protected]",
    "patientTimeZone": "America/New_York",
    "date": "2023-10-01T00:00:00Z",
    "startTime": "10:00",
    "endTime": "11:00",
    "startDateTime": "2023-10-01T10:00:00Z",
    "endDateTime": "2023-10-01T11:00:00Z",
    "token": "token-1234",
    "timeZone": "America/New_York",
    "note": "Patient requested a follow-up",
    "locationType": "GOOGLE_MAPS",
    "locationInfo": "Room 101",
    "externalId": "ext-12345",
    "attributes": {
      "key": "value"
    },
    "status": "BOOKED",
    "cancellationReason": "Patient no-show",
    "customCancellationReason": "Patient requested reschedule",
    "serviceProviderAttributes": {
      "key": "value"
    },
    "skipExternalSync": true,
    "parentResourceId": true,
    "isProviderUnavailable": true,
    "parentResource": {
      "id": "12345",
      "appointmentTypeId": "67890",
      "priority": "HIGH",
      "patientId": "54321",
      "consumerUuid": "uuid-1234",
      "firstName": "John",
      "lastName": "Doe",
      "birthDate": "1990-01-01T00:00:00Z",
      "gender": "Male",
      "email": "[email protected]",
      "patientTimeZone": "America/New_York",
      "date": "2023-10-01T00:00:00Z",
      "startTime": "10:00",
      "endTime": "11:00",
      "startDateTime": "2023-10-01T10:00:00Z",
      "endDateTime": "2023-10-01T11:00:00Z",
      "token": "token-1234",
      "timeZone": "America/New_York",
      "note": "Patient requested a follow-up",
      "locationType": "GOOGLE_MAPS",
      "locationInfo": "Room 101",
      "externalId": "ext-12345",
      "attributes": {
        "key": "value"
      },
      "status": "BOOKED",
      "cancellationReason": "Patient no-show",
      "customCancellationReason": "Patient requested reschedule",
      "serviceProviderAttributes": {
        "key": "value"
      },
      "skipExternalSync": true,
      "parentResourceId": true,
      "isProviderUnavailable": true,
      "parentResource": {
        "id": "12345",
        "appointmentTypeId": "67890",
        "priority": "HIGH",
        "patientId": "54321",
        "consumerUuid": "uuid-1234",
        "firstName": "John",
        "lastName": "Doe",
        "birthDate": "1990-01-01T00:00:00Z",
        "gender": "Male",
        "email": "[email protected]",
        "patientTimeZone": "America/New_York",
        "date": "2023-10-01T00:00:00Z",
        "startTime": "10:00",
        "endTime": "11:00",
        "startDateTime": "2023-10-01T10:00:00Z",
        "endDateTime": "2023-10-01T11:00:00Z",
        "token": "token-1234",
        "timeZone": "America/New_York",
        "note": "Patient requested a follow-up",
        "locationType": "GOOGLE_MAPS",
        "locationInfo": "Room 101",
        "externalId": "ext-12345",
        "attributes": {
          "key": "value"
        },
        "status": "BOOKED",
        "cancellationReason": "Patient no-show",
        "customCancellationReason": "Patient requested reschedule",
        "serviceProviderAttributes": {
          "key": "value"
        },
        "skipExternalSync": true,
        "parentResourceId": true,
        "isProviderUnavailable": true,
        "parentResource": {
          "id": "12345",
          "appointmentTypeId": "67890",
          "priority": "HIGH",
          "patientId": "54321",
          "consumerUuid": "uuid-1234",
          "firstName": "John",
          "lastName": "Doe",
          "birthDate": "1990-01-01T00:00:00Z",
          "gender": "Male",
          "email": "[email protected]",
          "patientTimeZone": "America/New_York",
          "date": "2023-10-01T00:00:00Z",
          "startTime": "10:00",
          "endTime": "11:00",
          "startDateTime": "2023-10-01T10:00:00Z",
          "endDateTime": "2023-10-01T11:00:00Z",
          "token": "token-1234",
          "timeZone": "America/New_York",
          "note": "Patient requested a follow-up",
          "locationType": "GOOGLE_MAPS",
          "locationInfo": "Room 101",
          "externalId": "ext-12345",
          "attributes": {
            "key": "value"
          },
          "status": "BOOKED",
          "cancellationReason": "Patient no-show",
          "customCancellationReason": "Patient requested reschedule",
          "serviceProviderAttributes": {
            "key": "value"
          },
          "skipExternalSync": true,
          "parentResourceId": true,
          "isProviderUnavailable": true,
          "parentResource": {
            "id": "12345",
            "appointmentTypeId": "67890",
            "priority": "HIGH",
            "patientId": "54321",
            "consumerUuid": "uuid-1234",
            "firstName": "John",
            "lastName": "Doe",
            "birthDate": "1990-01-01T00:00:00Z",
            "gender": "Male",
            "email": "[email protected]",
            "patientTimeZone": "America/New_York",
            "date": "2023-10-01T00:00:00Z",
            "startTime": "10:00",
            "endTime": "11:00",
            "startDateTime": "2023-10-01T10:00:00Z",
            "endDateTime": "2023-10-01T11:00:00Z",
            "token": "token-1234",
            "timeZone": "America/New_York",
            "note": "Patient requested a follow-up",
            "locationType": "GOOGLE_MAPS",
            "locationInfo": "Room 101",
            "externalId": "ext-12345",
            "attributes": {
              "key": "value"
            },
            "status": "BOOKED",
            "cancellationReason": "Patient no-show",
            "customCancellationReason": "Patient requested reschedule",
            "serviceProviderAttributes": {
              "key": "value"
            },
            "skipExternalSync": true,
            "parentResourceId": true,
            "isProviderUnavailable": true,
            "parentResource": "[Circular Reference]",
            "resources": "[Circular Reference]",
            "appointmentType": "[Circular Reference]",
            "participants": "[Circular Reference]",
            "relatedPatients": "[Circular Reference]",
            "relatedProviders": "[Circular Reference]",
            "appointmentWorkflow": {
              "id": "12345",
              "appointmentId": "67890",
              "workflowId": 1,
              "appointmentWorkflowTask": []
            },
            "updatedBy": {
              "key": "value"
            },
            "openTeleRoom": "[Circular Reference]",
            "patientMobileNumber": "[phone]",
            "schedulerAppointmentAction": [],
            "isAssigneeChanged": true,
            "appointmentLocationAddressId": 1,
            "appointmentLocationAddress": {
              "id": 12,
              "title": "Title",
              "line1": "10 Riverside",
              "line2": "Drive Mira Loma",
              "country": "United States",
              "state": "New Jersey",
              "district": "Passaic County",
              "city": "Woodland Park",
              "addressType": "PRIMARY",
              "zipCode": "123456",
              "latitude": 12.34,
              "longitude": 12.34,
              "deleted": true,
              "createdAt": "2021-01-01",
              "updatedAt": "2021-01-01"
            },
            "referralId": 1,
            "referral": "[Circular Reference]",
            "populationTags": [],
            "invoice": {
              "id": 123,
              "amount": "100.00",
              "personId": 123,
              "organizationId": 456,
              "status": "paid",
              "currency": "USD",
              "description": "Invoice for services rendered",
              "appointmentId": 789,
              "externalId": "ext_inv_123",
              "createdAt": "2023-01-01T00:00:00.000Z",
              "updatedAt": "2023-01-02T00:00:00.000Z",
              "invoiceToInvoiceItems": [],
              "url": "https://stripe.com/invoice/123"
            }
          },
          "resources": [],
          "appointmentType": {
            "id": "12345",
            "name": "Consultation",
            "priority": "HIGH",
            "description": "A brief consultation session",
            "durationInMinutes": 30,
            "appointmentTypeTemplateId": 1,
            "serviceProviderScheduleId": 2,
            "useDefaultAvailability": true,
            "overlappingSlots": true,
            "disabled": true,
            "externalId": "welkin-encounter-template",
            "schedulerSystemUserId": "user-123",
            "serviceProviderId": 1,
            "startDate": "2023-01-01T00:00:00Z",
            "endDate": "2023-12-31T23:59:59Z",
            "color": "#FF5733",
            "locationType": "GOOGLE_MAPS",
            "userId": "user-456",
            "user": "[Circular Reference]",
            "maximumAppointmentsPerDay": 10,
            "maximumAppointmentsPerWeek": 1,
            "serviceProviderRole": "CLIENT_MANAGER",
            "bookingHorizon": 30,
            "attributes": {},
            "addressGroupId": 1,
            "addressGroup": "[Circular Reference]"
          },
          "participants": [],
          "relatedPatients": [],
          "relatedProviders": [],
          "appointmentWorkflow": {
            "id": "12345",
            "appointmentId": "67890",
            "workflowId": 1,
            "appointmentWorkflowTask": []
          },
          "updatedBy": {
            "key": "value"
          },
          "openTeleRoom": [],
          "patientMobileNumber": "[phone]",
          "schedulerAppointmentAction": [],
          "isAssigneeChanged": true,
          "appointmentLocationAddressId": 1,
          "appointmentLocationAddress": {
            "id": 12,
            "title": "Title",
            "line1": "10 Riverside",
            "line2": "Drive Mira Loma",
            "country": "United States",
            "state": "New Jersey",
            "district": "Passaic County",
            "city": "Woodland Park",
            "addressType": "PRIMARY",
            "zipCode": "123456",
            "latitude": 12.34,
            "longitude": 12.34,
            "deleted": true,
            "createdAt": "2021-01-01",
            "updatedAt": "2021-01-01"
          },
          "referralId": 1,
          "referral": {
            "id": 1,
            "patientId": 123,
            "patient": {},
            "requesterAgent": "12345",
            "requesterAgentType": "Organization",
            "requesterOnBehalfOf": "12345",
            "reason": "12345",
            "specialty": "cardiology",
            "description": "text",
            "source": "Zoho",
            "sourceId": "Zoho",
            "status": "draft",
            "default": true,
            "startDateTime": "2023-07-11T10:30:00Z",
            "expiryDateTime": "2023-07-11T10:30:00Z",
            "schedulerAppointments": "[Circular Reference]",
            "createdAt": "2023-07-11T10:30:00Z",
            "updatedAt": "2023-07-11T10:30:00Z"
          },
          "populationTags": [],
          "invoice": {
            "id": 123,
            "amount": "100.00",
            "personId": 123,
            "organizationId": 456,
            "status": "paid",
            "currency": "USD",
            "description": "Invoice for services rendered",
            "appointmentId": 789,
            "externalId": "ext_inv_123",
            "createdAt": "2023-01-01T00:00:00.000Z",
            "updatedAt": "2023-01-02T00:00:00.000Z",
            "invoiceToInvoiceItems": [],
            "url": "https://stripe.com/invoice/123"
          }
        },
        "resources": [],
        "appointmentType": {
          "id": "12345",
          "name": "Consultation",
          "priority": "HIGH",
          "description": "A brief consultation session",
          "durationInMinutes": 30,
          "appointmentTypeTemplateId": 1,
          "serviceProviderScheduleId": 2,
          "useDefaultAvailability": true,
          "overlappingSlots": true,
          "disabled": true,
          "externalId": "welkin-encounter-template",
          "schedulerSystemUserId": "user-123",
          "serviceProviderId": 1,
          "startDate": "2023-01-01T00:00:00Z",
          "endDate": "2023-12-31T23:59:59Z",
          "color": "#FF5733",
          "locationType": "GOOGLE_MAPS",
          "userId": "user-456",
          "user": "[Circular Reference]",
          "maximumAppointmentsPerDay": 10,
          "maximumAppointmentsPerWeek": 1,
          "serviceProviderRole": "CLIENT_MANAGER",
          "bookingHorizon": 30,
          "attributes": {},
          "addressGroupId": 1,
          "addressGroup": "[Circular Reference]"
        },
        "participants": [],
        "relatedPatients": [],
        "relatedProviders": [],
        "appointmentWorkflow": {
          "id": "12345",
          "appointmentId": "67890",
          "workflowId": 1,
          "appointmentWorkflowTask": []
        },
        "updatedBy": {
          "key": "value"
        },
        "openTeleRoom": [],
        "patientMobileNumber": "[phone]",
        "schedulerAppointmentAction": [],
        "isAssigneeChanged": true,
        "appointmentLocationAddressId": 1,
        "appointmentLocationAddress": {
          "id": 12,
          "title": "Title",
          "line1": "10 Riverside",
          "line2": "Drive Mira Loma",
          "country": "United States",
          "state": "New Jersey",
          "district": "Passaic County",
          "city": "Woodland Park",
          "addressType": "PRIMARY",
          "zipCode": "123456",
          "latitude": 12.34,
          "longitude": 12.34,
          "deleted": true,
          "createdAt": "2021-01-01",
          "updatedAt": "2021-01-01"
        },
        "referralId": 1,
        "referral": {
          "id": 1,
          "patientId": 123,
          "patient": {},
          "requesterAgent": "12345",
          "requesterAgentType": "Organization",
          "requesterOnBehalfOf": "12345",
          "reason": "12345",
          "specialty": "cardiology",
          "description": "text",
          "source": "Zoho",
          "sourceId": "Zoho",
          "status": "draft",
          "default": true,
          "startDateTime": "2023-07-11T10:30:00Z",
          "expiryDateTime": "2023-07-11T10:30:00Z",
          "schedulerAppointments": "[Circular Reference]",
          "createdAt": "2023-07-11T10:30:00Z",
          "updatedAt": "2023-07-11T10:30:00Z"
        },
        "populationTags": [],
        "invoice": {
          "id": 123,
          "amount": "100.00",
          "personId": 123,
          "organizationId": 456,
          "status": "paid",
          "currency": "USD",
          "description": "Invoice for services rendered",
          "appointmentId": 789,
          "externalId": "ext_inv_123",
          "createdAt": "2023-01-01T00:00:00.000Z",
          "updatedAt": "2023-01-02T00:00:00.000Z",
          "invoiceToInvoiceItems": [],
          "url": "https://stripe.com/invoice/123"
        }
      },
      "resources": [],
      "appointmentType": {
        "id": "12345",
        "name": "Consultation",
        "priority": "HIGH",
        "description": "A brief consultation session",
        "durationInMinutes": 30,
        "appointmentTypeTemplateId": 1,
        "serviceProviderScheduleId": 2,
        "useDefaultAvailability": true,
        "overlappingSlots": true,
        "disabled": true,
        "externalId": "welkin-encounter-template",
        "schedulerSystemUserId": "user-123",
        "serviceProviderId": 1,
        "startDate": "2023-01-01T00:00:00Z",
        "endDate": "2023-12-31T23:59:59Z",
        "color": "#FF5733",
        "locationType": "GOOGLE_MAPS",
        "userId": "user-456",
        "user": "[Circular Reference]",
        "maximumAppointmentsPerDay": 10,
        "maximumAppointmentsPerWeek": 1,
        "serviceProviderRole": "CLIENT_MANAGER",
        "bookingHorizon": 30,
        "attributes": {},
        "addressGroupId": 1,
        "addressGroup": "[Circular Reference]"
      },
      "participants": [],
      "relatedPatients": [],
      "relatedProviders": [],
      "appointmentWorkflow": {
        "id": "12345",
        "appointmentId": "67890",
        "workflowId": 1,
        "appointmentWorkflowTask": []
      },
      "updatedBy": {
        "key": "value"
      },
      "openTeleRoom": [],
      "patientMobileNumber": "[phone]",
      "schedulerAppointmentAction": [],
      "isAssigneeChanged": true,
      "appointmentLocationAddressId": 1,
      "appointmentLocationAddress": {
        "id": 12,
        "title": "Title",
        "line1": "10 Riverside",
        "line2": "Drive Mira Loma",
        "country": "United States",
        "state": "New Jersey",
        "district": "Passaic County",
        "city": "Woodland Park",
        "addressType": "PRIMARY",
        "zipCode": "123456",
        "latitude": 12.34,
        "longitude": 12.34,
        "deleted": true,
        "createdAt": "2021-01-01",
        "updatedAt": "2021-01-01"
      },
      "referralId": 1,
      "referral": {
        "id": 1,
        "patientId": 123,
        "patient": {},
        "requesterAgent": "12345",
        "requesterAgentType": "Organization",
        "requesterOnBehalfOf": "12345",
        "reason": "12345",
        "specialty": "cardiology",
        "description": "text",
        "source": "Zoho",
        "sourceId": "Zoho",
        "status": "draft",
        "default": true,
        "startDateTime": "2023-07-11T10:30:00Z",
        "expiryDateTime": "2023-07-11T10:30:00Z",
        "schedulerAppointments": "[Circular Reference]",
        "createdAt": "2023-07-11T10:30:00Z",
        "updatedAt": "2023-07-11T10:30:00Z"
      },
      "populationTags": [],
      "invoice": {
        "id": 123,
        "amount": "100.00",
        "personId": 123,
        "organizationId": 456,
        "status": "paid",
        "currency": "USD",
        "description": "Invoice for services rendered",
        "appointmentId": 789,
        "externalId": "ext_inv_123",
        "createdAt": "2023-01-01T00:00:00.000Z",
        "updatedAt": "2023-01-02T00:00:00.000Z",
        "invoiceToInvoiceItems": [],
        "url": "https://stripe.com/invoice/123"
      }
    },
    "resources": [],
    "appointmentType": {
      "id": "12345",
      "name": "Consultation",
      "priority": "HIGH",
      "description": "A brief consultation session",
      "durationInMinutes": 30,
      "appointmentTypeTemplateId": 1,
      "serviceProviderScheduleId": 2,
      "useDefaultAvailability": true,
      "overlappingSlots": true,
      "disabled": true,
      "externalId": "welkin-encounter-template",
      "schedulerSystemUserId": "user-123",
      "serviceProviderId": 1,
      "startDate": "2023-01-01T00:00:00Z",
      "endDate": "2023-12-31T23:59:59Z",
      "color": "#FF5733",
      "locationType": "GOOGLE_MAPS",
      "userId": "user-456",
      "user": "[Circular Reference]",
      "maximumAppointmentsPerDay": 10,
      "maximumAppointmentsPerWeek": 1,
      "serviceProviderRole": "CLIENT_MANAGER",
      "bookingHorizon": 30,
      "attributes": {},
      "addressGroupId": 1,
      "addressGroup": "[Circular Reference]"
    },
    "participants": [],
    "relatedPatients": [],
    "relatedProviders": [],
    "appointmentWorkflow": {
      "id": "12345",
      "appointmentId": "67890",
      "workflowId": 1,
      "appointmentWorkflowTask": []
    },
    "updatedBy": {
      "key": "value"
    },
    "openTeleRoom": [],
    "patientMobileNumber": "[phone]",
    "schedulerAppointmentAction": [],
    "isAssigneeChanged": true,
    "appointmentLocationAddressId": 1,
    "appointmentLocationAddress": {
      "id": 12,
      "title": "Title",
      "line1": "10 Riverside",
      "line2": "Drive Mira Loma",
      "country": "United States",
      "state": "New Jersey",
      "district": "Passaic County",
      "city": "Woodland Park",
      "addressType": "PRIMARY",
      "zipCode": "123456",
      "latitude": 12.34,
      "longitude": 12.34,
      "deleted": true,
      "createdAt": "2021-01-01",
      "updatedAt": "2021-01-01"
    },
    "referralId": 1,
    "referral": {
      "id": 1,
      "patientId": 123,
      "patient": {},
      "requesterAgent": "12345",
      "requesterAgentType": "Organization",
      "requesterOnBehalfOf": "12345",
      "reason": "12345",
      "specialty": "cardiology",
      "description": "text",
      "source": "Zoho",
      "sourceId": "Zoho",
      "status": "draft",
      "default": true,
      "startDateTime": "2023-07-11T10:30:00Z",
      "expiryDateTime": "2023-07-11T10:30:00Z",
      "schedulerAppointments": "[Circular Reference]",
      "createdAt": "2023-07-11T10:30:00Z",
      "updatedAt": "2023-07-11T10:30:00Z"
    },
    "populationTags": [],
    "invoice": {
      "id": 123,
      "amount": "100.00",
      "personId": 123,
      "organizationId": 456,
      "status": "paid",
      "currency": "USD",
      "description": "Invoice for services rendered",
      "appointmentId": 789,
      "externalId": "ext_inv_123",
      "createdAt": "2023-01-01T00:00:00.000Z",
      "updatedAt": "2023-01-02T00:00:00.000Z",
      "invoiceToInvoiceItems": [],
      "url": "https://stripe.com/invoice/123"
    }
  },
  "resources": [],
  "appointmentType": {
    "id": "12345",
    "name": "Consultation",
    "priority": "HIGH",
    "description": "A brief consultation session",
    "durationInMinutes": 30,
    "appointmentTypeTemplateId": 1,
    "serviceProviderScheduleId": 2,
    "useDefaultAvailability": true,
    "overlappingSlots": true,
    "disabled": true,
    "externalId": "welkin-encounter-template",
    "schedulerSystemUserId": "user-123",
    "serviceProviderId": 1,
    "startDate": "2023-01-01T00:00:00Z",
    "endDate": "2023-12-31T23:59:59Z",
    "color": "#FF5733",
    "locationType": "GOOGLE_MAPS",
    "userId": "user-456",
    "user": "[Circular Reference]",
    "maximumAppointmentsPerDay": 10,
    "maximumAppointmentsPerWeek": 1,
    "serviceProviderRole": "CLIENT_MANAGER",
    "bookingHorizon": 30,
    "attributes": {},
    "addressGroupId": 1,
    "addressGroup": "[Circular Reference]"
  },
  "participants": [],
  "relatedPatients": [],
  "relatedProviders": [],
  "appointmentWorkflow": {
    "id": "12345",
    "appointmentId": "67890",
    "workflowId": 1,
    "appointmentWorkflowTask": []
  },
  "updatedBy": {
    "key": "value"
  },
  "openTeleRoom": [],
  "patientMobileNumber": "[phone]",
  "schedulerAppointmentAction": [],
  "isAssigneeChanged": true,
  "appointmentLocationAddressId": 1,
  "appointmentLocationAddress": {
    "id": 12,
    "title": "Title",
    "line1": "10 Riverside",
    "line2": "Drive Mira Loma",
    "country": "United States",
    "state": "New Jersey",
    "district": "Passaic County",
    "city": "Woodland Park",
    "addressType": "PRIMARY",
    "zipCode": "123456",
    "latitude": 12.34,
    "longitude": 12.34,
    "deleted": true,
    "createdAt": "2021-01-01",
    "updatedAt": "2021-01-01"
  },
  "referralId": 1,
  "referral": {
    "id": 1,
    "patientId": 123,
    "patient": {},
    "requesterAgent": "12345",
    "requesterAgentType": "Organization",
    "requesterOnBehalfOf": "12345",
    "reason": "12345",
    "specialty": "cardiology",
    "description": "text",
    "source": "Zoho",
    "sourceId": "Zoho",
    "status": "draft",
    "default": true,
    "startDateTime": "2023-07-11T10:30:00Z",
    "expiryDateTime": "2023-07-11T10:30:00Z",
    "schedulerAppointments": "[Circular Reference]",
    "createdAt": "2023-07-11T10:30:00Z",
    "updatedAt": "2023-07-11T10:30:00Z"
  },
  "populationTags": [],
  "invoice": {
    "id": 123,
    "amount": "100.00",
    "personId": 123,
    "organizationId": 456,
    "status": "paid",
    "currency": "USD",
    "description": "Invoice for services rendered",
    "appointmentId": 789,
    "externalId": "ext_inv_123",
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-02T00:00:00.000Z",
    "invoiceToInvoiceItems": [],
    "url": "https://stripe.com/invoice/123"
  }
}