Appointments

Retrieves an appointment by their unique identifier and numeric instance

Retrieves an appointment by their unique identifier and numeric instance.

Required scope: alto/read:appointments

get/appointments/{appointmentId}/{instanceId}

Request

  • Base URL: https://api.alto.zoopladev.co.uk
  • URL: https://api.alto.zoopladev.co.uk/appointments/{appointmentId}/{instanceId}
  • Auth: appAuth (a scheme the document does not define)

Path parameters

appointmentIdinteger required

The unique identifier of the appointment

instanceIdinteger required

The numeric instance of an appointment; this value is only greater than zero for general appointment types that are marked as recurring and represents the xth instance of a given appointment in a recurring series.

Headers

AgencyRefstring required

Response

Appointment retrieved for requested appointment id and instance.

idinteger

The unique identifier of the appointment

instanceIdinteger

The numeric instance of an appointment; this value is only greater than zero for general appointment types that are marked as recurring and represents the xth instance of a given appointment in a recurring series.

type'Unspecified' | 'General' | 'Valuation' | 'Viewing' | 'Communication' | 'InternalMessage' | 'Offer' | 'AgreedOffer' | 'Note' | 'AuditedChange' | 'StickyNote' | 'FinancialTransaction' | 'Marketing' | 'Creation' | 'SyncedEmail' | 'AccountingTransaction' | 'WorkOrderEvent' | 'TenancyEvent' | 'FollowUp' | 'PersonalInformationRequest' | 'TdsEvent' | 'SigningRequest' | 'MaintenanceRequest' | 'DocumentSharing' | 'ConveyancerReferral'

The type of the appointment

startDatestring date-time

The appointment start date and time, returned as a local (UK) diary time with no timezone offset.

endDatestring date-time

The appointment end date and time, returned as a local (UK) diary time with no timezone offset.

createdDatestring date-time

The appointment's creation date and time in ISO 8601 format

modifiedDatestring date-time

The appointment's last modified date and time in ISO 8601 format

titlestring nullable

The title of the appointment. For general appointments this refers to the appointment entry type

status'Unspecified' | 'NotYetBooked' | 'Active' | 'CancelledByOffice' | 'CancelledByOwner' | 'CancelledByApplicant' | 'CancelledByContact'

The status of the appointment

isCancelledboolean

Indicates whether the appointment has a cancelled status; An appointment is only cancelled if the appointment status is not set to either Active or NotYetBooked

Example response

{
  "id": 76543,
  "type": "Viewing",
  "startDate": "2024-11-01T14:07:17.0000000+00:00",
  "endDate": "2024-11-01T14:07:17.0000000+00:00",
  "createdDate": "2024-11-01T14:07:17.0000000+00:00",
  "modifiedDate": "2024-11-01T14:07:17.0000000+00:00",
  "title": "FS appointment",
  "status": "Active",
  "negotiators": [
    {
      "id": "45678"
    }
  ],
  "properties": [
    {
      "id": "112233"
    }
  ],
  "contacts": [
    {
      "id": "123456"
    }
  ],
  "viewingDetails": {
    "internalNotes": "Internal notes",
    "applicantFeedback": "Feedback"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.