Leads

Gets a paginated list of Leads

Retrieves a paginated list of leads in the requested state of processing for a given AgencyRef and all permissible branches. Required scope: alto/read:leads

get/leads

Request

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

Query parameters

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

Required: The modified date and time in ISO 8601 format from which Leads should be retrieved from.

modified-tostring date-time
Example:2023-12-31T23:59:59.0000000+00:00

Required: The modified date and time in ISO 8601 format from which Leads should be retrieved up until.

lead-status'Unspecified' | 'Unprocessed' | 'Processed' | 'Rejected' | 'Accepted'

Optional: The LeadStatus type for filtering leads. Permitted values are:

  • Unspecified: Leads that have not been able to be processed after import
  • Unprocessed: Leads that are queued up for processing after import
  • Processed: Leads that are ready for triage
  • Rejected: Leads that have been triaged and rejected by the agent or party acting on behalf of the agent
  • Accepted: Leads that have been triaged and accepted by the agent or party acting on behalf of the agent

NOTE: If not set, this will default to Accepted

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

Required: The enquiry date and time in ISO 8601 format from which Leads should be retrieved from.

enquiry-tostring date-time
Example:2023-12-31T23:59:59.0000000+00:00

Required: The enquiry date and time in ISO 8601 format from which Leads should be retrieved up until.

next-tokenstring

Sets the token for the next page of resultss.

max-resultsinteger

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

Headers

AgencyRefstring required

A GUID required in the header of all API requests that grants access to an agent's data

Response

OK

Example response

{
  "items": [
    {
      "id": "76543",
      "branchId": "11",
      "enquiryDate": "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",
      "enquirerDetails": {
        "title": "Ms",
        "forename": "Jane",
        "surname": "Smith",
        "phoneNumberDay": "07683726192",
        "phoneNumberEve": "07683726192",
        "email": "jane.smith@enquirer.com",
        "address": {
          "houseName": "Oak Lodge",
          "houseNumber": "14",
          "street": "Oak Street",
          "locality": "St Clement",
          "town": "London",
          "county": "Hampshire",
          "country": "UK",
          "postcode": "SW45 3AP"
        }
      },
      "contact": {
        "id": "123456"
      },
      "properties": [
        {
          "id": "123456"
        }
      ]
    }
  ]
}

Changes

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