Appointments

Get negotiator's appointments within a selected time range.

Retrieves a paginated list of the requested negotiator's appointments within the selected time range, grouped by negotiator. Required scope: alto/read:appointments

get/appointments/negotiators

Request

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

Query parameters

start-datestring date-time required
Example:2023-01-01T00:00:00.0000000+00:00

Required: The start date and time in ISO 8601 format for filtering negotiator's appointments. Interpreted as UK local diary time: a value with a UTC marker (a trailing Z) or an explicit offset is converted to UK local time (Europe/London); a plain local value with no offset is taken as-is.

end-datestring date-time required
Example:2023-01-01T00:00:00.0000000+00:00

Required: The end date and time in ISO 8601 format for filtering negotiator's appointments. Interpreted as UK local diary time: a value with a UTC marker (a trailing Z) or an explicit offset is converted to UK local time (Europe/London); a plain local value with no offset is taken as-is.

type-id'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'
Example:General

Optional: The appointment type for filtering negotiator appointments; NOTE: If not set, this will return all appointment types

next-tokenstring

The token for the next page of results.

max-resultsinteger
Example:50

The maximum number of results to return. The default value is 50, and the maximum value is 250.

negotiator-idinteger[] required

Headers

AgencyRefstring required

Response

Appointments retrieved for negotiator.

Example response

{
  "items": [
    {
      "negotiatorId": 67890,
      "appointments": [
        {
          "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.