Field Definitions

This is a collection of the definitions for all the fields we surface through both the Poll and Push mechanisms.
This list also includes the default values for any field as well as the possible enum values.

Both

The fields in this section are shared across both models. Any fields that are in sub objects of either Applicant or Appraisal leads will be linked through anchor tags.

• ID
• Created At
• Enquiry Type
• Message
• Property Use
• Is Overseas
• Portal Lead ID
• Portal Branch ID
• Portal Company ID
• Source Branch ID
• Recipient Email
• Property Type
• Contact
• Estimate

ID

Model: Both
Type: String
Default Value: ""
Example: "6f762f7a-14e5-46df-ae87-f997acd3abf3"

The lead ID created by this API - unlike Portal Lead ID, this will always be unique.

---

Created At

Model: Both
Type: Date/Time
Default Value: "0001-01-01T00:00Z"
Example: "2022-06-07T17:32Z"

The time the lead was created at in ISO 8601 format including time (to second resolution) and timezone (always UTC): [YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]Z.

---

Enquiry Type

Model: Both
Type: Enum
Default Value: "ENQUIRY_TYPE_UNSPECIFIED"

What type of enquiry the user is making. Whether sales or lettings.

---

Message

Model: Both
Type: String
Default Value: ""
Example: "Hello I would like to buy this home"

The message that the user has sent, this may also include additional information such as viewing times, contact preferences.

---

Property Use

Model: Both
Type: Enum
Default Value: "PROPERTY_USE_UNSPECIFIED"

The property's primary use.

---

Is Overseas

Model: Both
Type: Boolean
Default Value: false

This flag denotes whether the lead is for an overseas property or not.

---

Portal Lead ID

Model: Both
Type: String
Default Value: ""
Example: "3c1593f5-96f9-436d-9db7-e5311b937dc3"

The lead ID generated by the Zoopla portal - NB this is not guaranteed to be unique, and is primarily used for debugging purposes.

---

Portal Branch ID

Model: Both
Type: String
Default Value: ""
Example: "1234"

The Zoopla branch ID associated with the relevant branch by our portal.

---

Portal Company ID

Model: Both
Type: String
Default Value: ""
Example: "1234"

The Zoopla company ID associated with the relevant company by our portal.

---

Source Branch ID

Model: Both
Type: String
Default Value: ""
Example: " "abc_1234""

An optional branch ID field that can be specified by the branch itself, ie to allow association with your own internal branch ID.

---

Recipient Email

Model: Both
Type: String
Default Value: ""
Example: "[email protected]"

The email address of where the lead will be sent.

---

Property Type

Model: Both
Type: Enum
Default Value: "PROPERTY_TYPE_UNSPECIFIED"

This is the available types of property that we have.

---

Contact

Model: Both
Type: Object

The contact information of the sender of the lead.

Contact - First Name

Model: Both
Type: String
Default Value: ""
Example: "Joe"

The first name of the user submitting the lead.

Contact - Last Name

Model: Both
Type: String
Default Value: ""
Example: "Bloggs"

The last name of the user submitting the lead.

Contact - Email

Model: Both
Type: String
Default Value: ""
Example: "[email protected]"

The email address of the user submitting the lead.

Contact - Phone Number

Model: Both
Type: String
Default Value: ""
Example: "07777777777"

The phone number of the user as entered by themselves when submitting the lead.

Contact - Preferences

Model: Both
Type: Object
Default Value: null

How and when the user who submitted the lead would like to be contacted.

Contact - Preferences - Method

Model: Both
Type: Enum
Default Value: "CONTACT_METHOD_UNSPECIFIED"

The method by which the user would prefer to be contacted.

Contact - Preferences - Time

Model: Both
Type: Enum
Default Value: "TIME_PREFERENCE_UNSPECIFIED"

The time of day in which the user would prefer to be contacted. This is only set if the user would prefer to be contacted by phone.

---

Estimate

Model: Both
Type: Object

This Object represents the Zoopla price estimate information for a given property.

Estimate - Lower Range

Model: Both
Type: Int
Default Value: 0
Example: 400000

This field represents the lower range of the Zoopla estimate of the property's price.

Estimate - Upper Range

Model: Both
Type: Int
Default Value: 0
Example: 600000

This field represents the upper range of the Zoopla estimate of the property's price.

Estimate - Value

Model: Both
Type: Int
Default Value: 0
Example: 500000

This field represents the value of the Zoopla estimate of the property's price.

Estimate - Confidence

Model: Both
Type: Int
Default Value: 0
Example: 75

This field represents the confidence Zoopla has in its estimate out of 100 percent.

Estimate - Confidence Band

Model: Both
Type: Enum
Default Value: "CONFIDENCE_BAND_UNSPECIFIED"

This field is a textual representation of the confidence rating above.

---

Applicant

The values in this section are specific to Applicant leads. If they use a shared enum this will be linked to the relevant section above.

• Intent
• Viewing Times
• Organise Viewing
• Request Property Details
• Consumer Situation
• Consumer Postcode
• Source
• Portal Source
• Search Criteria
• Listing Details

Applicant Intent

Model: Applicant
Type: Enum
Default Value: "APPLICANT_INTENT_UNSPECIFIED"

The applicant's intention for why they sent the lead.

---

Organise Viewing

Model: Applicant
Type: Boolean
Default Value: false

Whether or not the user has requested a viewing.

---

Request Property Details

Model: Applicant
Type: Boolean
Default Value: false

Whether or not the user would like additional details about the listing.

---

Consumer Situation

Model: Applicant
Type: Enum
Default Value: "CONSUMER_SITUATION_UNSPECIFIED"

The user's situation with regards to whether they have another property to sell/let or similar.

---

Consumer Postcode

Model: Applicant
Type: String
Default Value: ""
Example: "A12 3BC"

The postcode of the user's current address.

---

Applicant Lead Source

Model: Applicant
Type: Enum
Default Value: "APPLICANT_SOURCE_OTHER"

The portal or source where the applicant lead was submitted eg. zoopla.co.uk

---

[DEPRECATED] Source Ad_reach

Model: Applicant
Type: Enum
Default Value: "APPLICANT_SOURCE_AD_REACH"

This field specifies source for applicant lead a bare "Ad_Reach / Adreach" will be deprecated, and specific subsections of adreach such as Facebook, Google, Tiktok will be used in the future

Applicant Portal Source

Model: Applicant
Type: Enum
Default Value: "APPLICANT_PORTAL_SOURCE_UNSPECIFIED"

This identifies the location on the portal where this lead comes from. This is a product area such as from a listing, from an email_agent form or from a product such as "temptme".

---

Viewing Times

Model: Applicant
Type: Array of Viewing Time

An array of viewing times the user is available.

Viewing Time

Model: Applicant
Type: Object

This is a object representing the viewing time with the earliest and latest time they are available for the viewing.

Viewing Time - Earliest

Model: Applicant
Type: Date/Time
Default Value: "0001-01-01T00:00Z"
Example: "2022-06-07T12:00Z"

The earliest time the user is available for the viewing, in the format "2006-01-02T15:04:05Z" where both times are UTC.

Viewing Time - Latest

Model: Applicant
Type: Date/Time
Default Value: "0001-01-01T00:00Z"
Example: "2022-06-07T17:00Z"

The latest time the user is available for the viewing, in the format "2006-01-02T15:04:05Z" where both times are UTC.

---

Search Criteria

Model: Applicant
Type: Object

This contains the search parameters the users input to find the listing for which they submitted the lead.

Search Criteria - Radius

Model: Applicant
Type: Float64
Default Value: null
Example: 3

This is the radius around the location they wish to search for in miles.

Search Criteria - Minimum Bedrooms

Model: Applicant
Type: Int32
Default Value: null
Example 1

This is the minimum number of bedrooms the user wishes to have in a property.

Search Criteria - Maximum Bedrooms

Model: Applicant
Type: Int32
Default Value: null
Example 2

This is the maximum number of bedrooms the user wishes to have in a property.

Search Criteria - Minimum Price

Model: Applicant
Type: Float64
Default Value: null
Example 2000000

This is the minimum price of the property the user wishes to rent/buy in GBP.

Search Criteria - Maximum Price

Model: Applicant
Type: Float64
Default Value: null
Example 4000000

This is the maximum price of the property the user wishes to rent/buy in GBP.

Search Criteria - Price Frequency

Model: Applicant
Type: Enum
Default Value: "RENT_FREQUENCY_UNSPECIFIED"

This is the frequency of the minimum and maximum price if the property is for rent e.g. Week/Month.

Search Criteria - Property Type

Model: Applicant
Type: Enum
Default Value: "PROPERTY_TYPE_UNSPECIFIED"

This is the type of property the user has searched for and all the available values can be seen here.

Search Criteria - Location

Model: Applicant
Type: Object

This contains the location that the user searched for.

Search Criteria - Location - Alias

Model: Applicant
Type: String
Default Value: ""
Example: "Abbey Wood"

This field represents an area or suburb of a larger place that was searched for.

Search Criteria - Location - Area

Model: Applicant
Type: String
Default Value: ""
Example: "1234"

This field represents a Zoopla internal area ID.

Search Criteria - Location - Area Street

Model: Applicant
Type: String
Default Value: ""
Example: "New Street"

This field represents the street name that was searched for.

Search Criteria - Location - Country

Model: Applicant
Type: String
Default Value: ""
Example: "England"

This field represents the country that was searched for.

Search Criteria - Location - County Area

Model: Applicant
Type: String
Default Value: ""
Example: "Staffordshire"

This field represents the county that was searched for.

Search Criteria - Location - Incode

Model: Applicant
Type: String
Default Value: ""
Example: "3BC"

This field represents the incode of the postcode that was searched for.

Search Criteria - Location - Outcode

Model: Applicant
Type: String
Default Value: ""
Example: "A12"

This field represents the outcode of the postcode that was searched for.

Search Criteria - Location - Post Town

Model: Applicant
Type: String
Default Value: ""
Example: "Tamworth"

This field represents the town that was searched for.

Search Criteria - Location - Postal Area

Model: Applicant
Type: String
Default Value: ""
Example: "AB"

This field represents the post town as a 2 character string.

Search Criteria - Location - Region

Model: Applicant
Type: String
Default Value: ""
Example: "North West England"

This field represents the region that was searched for.

Search Criteria - Location - Country Code

Model: Applicant
Type: String
Default Value: ""
Example: "ES"

This field represents the 2 character country code of the country that was searched for. These are ISO 3166 alpha-2 codes.

---

Listing Details

Model: Applicant
Type: Object

Listing Details - ID

Model: Applicant
Type: String
Default Value: ""
Example: "123456789"

This field represents the unique ID of the listing this lead was sent for on the Zoopla website.

Listing Details - Bedrooms

Model: Applicant
Type: Int32
Default Value: null
Example: 1

This field represents the number of bedrooms for the listing the lead was sent for.

Listing Details - Bathrooms

Model: Applicant
Type: Int32
Default Value: null
Example: 2

This field represents the number of bathrooms for the listing the lead was sent for.

Listing Details - Receptions

Model: Applicant
Type: Int32
Default Value: null
Example: 3

This field represents the number of receptions for the listing the lead was sent for.

Listing Details - Life Cycle Status

Model: Applicant
Type: Enum
Default Value: "LIFE_CYCLE_STATUS_UNSPECIFIED"

This field represents the current status of the listing at the time the lead was sent.

[DEPRECATED] Listing Details - Property ID

Model: Applicant
Type: Int32
Default Value: 0
Example: 123456789

This field holds the internal Zoopla property ID for the property the listing was made for. This will often be 0 if we cannot match the listing address to a property address. N.B. this field is being deprecated as it will be replaced by UPRN.

Listing Details - Property Type

Model: Applicant
Type: Enum
Default Value: "PROPERTY_TYPE_UNSPECIFIED"

This is the type of property the listing is for and can be seen here.

Listing Details - Source ID

Model: Applicant
Type: String
Default Value: ""
Example: "def_5678"

This field is the source's identifier for the listing i.e. An optional field that can be specified by the agent to allow association with your own internal listing ID.

Listing Details - Branch ID

Model: Applicant
Type: Int
Default Value: 0
Example: 1234

This field is the internal Zoopla branch ID of the branch that uploaded the listing.

N.B. This field will become a string in a future release of the API.

Listing Details - URL

Model: Applicant
Type: String
Default Value: ""
Example: "https://zoopla.co.uk/to-rent/details/1234"

This field contains the URL where the listing was uploaded.

Listing Details - Category

Model: Applicant
Type: Enum
Default Value: "PROPERTY_USE_UNSPECIFIED"

This field represents the primary use of the property in the listing. The full list of values can be found here.

Listing Details - Estimate

Model: Applicant
Type: Object

This object represents the Zoopla price estimate information for the property in the listing.
The full version of this object can be found here.

Listing Details - Address

Model: Applicant
Type: Object

This object represents the address information of the listing that the lead was sent for.

Listing Details - Address - Property Number or Name

Model: Applicant
Type: String
Default Value: ""
Example: "12"

This field represents the name or number of the property in the listing.

Listing Details - Address - Street Name

Model: Applicant
Type: String
Default Value: ""
Example: "New Street"

This field represents the street name of the property in the listing.

Listing Details - Address - Locality

Model: Applicant
Type: String
Default Value: ""
Example: "Sutton Coldfield"

This field represents the familiar name of the area as it is referred to be local residents.

Listing Details - Address - Town or City

Model: Applicant
Type: String
Default Value: ""
Example: "Tamworth"

This field represents the name or the town or city that the property is in.

Listing Details - Address - Postcode

Model: Applicant
Type: String
Default Value: ""
Example: "A12 3BC"

This field represents the postcode of the property in the listing.

Listing Details - Address - Country Code

Model: Applicant
Default Value: Type: String
Default Value: ""
Example: "GB"

This field represents the two letter country code of the country the property is in. These are ISO 3166 alpha-2 codes.

Listing Details - Pricing

Model: Applicant
Type: Object

This object represents the information on how the listing was priced.

Listing Details - Pricing - Transaction Type

Model: Applicant
Type: Enum
Default Value: "TRANSACTION_TYPE_UNSPECIFIED"

This field represents whether the listing was a sale or rental listing.

Listing Details - Pricing - Currency Code

Model: Applicant
Type: String
Default Value: ""
Example: "GBP"

This field represents the currency that the listing was advertised in. These are ISO 4217 alpha-3 codes.

Listing Details - Pricing - Price

Model: Applicant
Type: Float32
Default Value: 0
Example: 200000

This field represents the price the listing was up for.

Listing Details - Pricing - Rent Frequency

Model: Applicant
Type: Enum
Default Value: "RENT_FREQUENCY_UNSPECIFIED"

This field represents the frequency of the rent that is advertised in the listing.

Listing Details - Images

Model: Applicant
Type: Array of Image
Default Value: [] or null

This field contains a list of image objects that were uploaded with the listing.

Listing Details - Image

Model: Applicant
Type: Object

This model represents information around an image uploaded as part of the listing.

Listing Details - Image - Original

Model: Applicant
Type: String
Default Value: ""
Example: "https://cdn.com/filename.jpg"

This field contains a URL to the original version of the image that was uploaded.

Listing Details - Image - CDN URL

Model: Applicant
Type: String
Default Value: ""
Example: "https://cdn.com"

This field contains the URL to the CDN where the alternative versions of the image are stored.

Listing Details - Image - Filename

Model: Applicant
Type: String
Default Value: ""
Example: "filename.jpg"

This field contains the original name of the file on the CDN so that you can manipulate it to retrieve the other resolutions if desired.

---

Appraisal

• Intent
• Just Curious
• Source
• Portal Source
• Property Details

Appraisal Intent

Model: Appraisal
Type: Enum
Default Value: "APPRAISAL_INTENT_UNSPECIFIED"

The vendor's intention behind sending the lead.

---

Just Curious

Model: Appraisal
Type: Boolean
Default Value: false

Whether the user who submitted the lead is looking to get their property appraised because they are just curious.

---

Appraisal Lead Source

Model: Appraisal
Type: Enum
Default Value: "APPRAISAL_SOURCE_OTHER"

The portal or source where the appraisal lead was submitted eg. zoopla.co.uk

---

Appraisal Portal Source

Model: Appraisal
Type: Enum
Default Value "APPRAISAL_PORTAL_SOURCE_UNSPECIFIED"

This identifies the location on the portal where this lead comes from. This is a product area such as from the valuation page, an email all form, or from a product such as "temptme".

---

Urgency

Model: Appraisal
Type: Enum
Default Value ""URGENCY_UNSPECIFIED""

This field specifies how urgent the user who submitted the lead is to get a resolution to their lead.

---

Property Details

Model: Appraisal
Type: Object

This field represents the information we know about the property the Appraisal lead is for.

[DEPRECATED] Property Details - ID

Model: Appraisal
Type: String
Default Value: ""
Example: "1234"

This field represents the internal Zoopla ID for the property the lead is for. N.B. this field is being deprecated as it will be replaced by UPRN.

Property Details - UPRN

Model: Appraisal
Type: Int
Default Value: 0
Example: 4567

This field represents the Unique Property Reference Number of the property the lead was submitted for.

Property Details - Bedrooms

Model: Appraisal
Type: Int32
Default Value: null
Example: 1

This field represents the number of bedrooms that the property has.

Property Details - Bathrooms

Model: Appraisal
Type: Int32
Default Value: null
Example: 2

This field represents the number of bathrooms that the property has.

Property Details - Receptions

Model: Appraisal
Type: Int32
Default Value: null
Example: 3

This field represents the number of receptions that the property has.

Property Details - Floor Area

Model: Appraisal
Type: Int
Default Value: 0
Example: 96

This field represents the floor area of the property in sq. metres.

Property Details - Tenure

Model: Appraisal
Type: String
Default Value: "Unspecified"
Example: "Freehold"

This field represents the tenure type of the property.

Property Details - Property Type

Model: Appraisal
Type: Enum
Default Value: "PROPERTY_TYPE_UNSPECIFIED"

This field represents the number of receptions the type of property the Appraisal is for and all the available values can be seen here.

Property Details - Last Sale Price

Model: Appraisal
Type: Float32
Default Value: 0
Example: 200000

This field represents the price the property was last sold at.

Property Details - Latitude

Model: Appraisal
Type: Float64
Default Value: 0
Example: 38.8951

This field represents the latitude of where the property is in the world.

Property Details - Longitude

Model: Appraisal
Type: Float64
Default Value: 0
Example: -77.0364

This field represents the Longitude of where the property is in the world.

Property Details - Estimate

Model: Appraisal
Type: Object

This object represents the Zoopla price estimate information for the property the Appraisal lead is for.
The full version of this object can be found here.

Property Details - Address

Model: Appraisal
Type: Object

This object represents the additional address information for the property that is the subject of the Appraisal lead.

Property Details - Address - Line 1

Model: Appraisal
Type: String
Default Value: ""
Example: "Flat 12, Apartment"

This field represents the first line of the property's address.

Property Details - Address - Line 2

Model: Appraisal
Type: String
Default Value: ""
Example: "New Street"

This field represents the second line of the property's address.

Property Details - Address - Line 3

Model: Appraisal
Type: String
Default Value: ""
Example: "Glascote"

This field represents the third line of the property's address.

Property Details - Address - Town

Model: Appraisal
Type: String
Default Value: ""
Example: "Tamworth"

This field represents the town that the property is in.

Property Details - Address - County

Model: Appraisal
Type: String
Default Value: ""
Example: "Staffordshire"

This field represents the county that the property is in.

Property Details - Address - Post Code

Model: Appraisal
Type: String
Default Value: ""
Example: "A12 3BC"

This field represents the post code of the property.

Property Details - Energy

Model: Appraisal
Type: Object

This object represents the energy efficiency information for the property that is the subject of the Appraisal lead.

Property Details - Energy - Efficiency

Model: Appraisal
Type: UInt8
Default Value: null
Example: 86

This field represents the EPC efficiency score of the property.

Property Details - Energy - Rating

Model: Appraisal
Type: String
Default Value: ""
Example: "B"

This field represents the EPC efficiency rating of the property.

---