Appointments

Get valuations within a selected time range.

Retrieves a paged collection of valuations per the search criteria, which must include at least a Created Date range.

get/appointments/valuations

Request

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

Query parameters

created-fromstring date-time
Example:2023-01-01T00:00:00.0000000+00:00

Required: The lower limit for created date and time in ISO 8601 format for filtering appointments

created-tostring date-time
Example:2023-01-01T00:00:00.0000000+00:00

Required: The upper limit for created date and time in ISO 8601 format for filtering appointments

negotiator-idsinteger[]

Optional: A comma-separated list of negotiator ids for filtering appointments NOTE: If not set, this will default to all negotiators in the searched branches

branch-idsinteger[]

Optional: A comma-separated list of branch ids for filtering appointments NOTE: If not set, this will default to all branches

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.

Headers

AgencyRefstring required

Response

Valuations retrieved.

Example response

{
  "items": [
    {
      "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.