Contacts

Get Person(s) by Contact Id

See glossary for definition of <a href="https://developers.zoopla.co.uk/docs/glossary#person">Person</a> and <a href="https://developers.zoopla.co.uk/docs/glossary#contact">Contact</a>.

get/contacts/{contactId}/persons

Request

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

Path parameters

contactIdstring required

The unique identifier for the Contact.

Headers

AgencyRefstring required

Response

Contact returned for Contact Id.

idstring nullable

The unique identifier for the resource.

category'Unknown' | 'Client' | 'Solicitor' | 'BuildingSociety' | 'Bank' | 'Publication' | 'EstateAgent' | 'ManagingAgent' | 'Developer' | 'Builder' | 'Utility' | 'Service' | 'PreviousClient' | 'Miscellaneous' | 'FinancialAdvisor' | 'Maintenance' | 'OnSiteSales' | 'ExternalPrinter' | 'OtherCategory1' | 'EstateAgentLocal' | 'Surveyor' | 'Supplier' | 'Accountant'
notesstring nullable

The notes for the contact

archivedboolean

The archived status of the contact.

companyNamestring nullable

The company name associated with the contact.

potentialVendorboolean

Indicates whether the contact has been flagged as a potential vendor.

potentialLandlordboolean

Indicates whether the contact has been flagged as a potential landlord.

modifiedDatestring date-time

When the contact was last modified.

Example response

{
  "people": [
    {
      "title": "Ms",
      "forename": "Jane",
      "surname": "Doe",
      "phoneNumbers": [
        {
          "preferenceOrder": 1,
          "type": "Mobile",
          "number": "01234567891",
          "description": "John's mobile"
        }
      ],
      "emailAddresses": [
        {
          "preferenceOrder": 2,
          "type": "Business",
          "address": "john.doe@business.com"
        }
      ]
    }
  ],
  "modifiedDate": "2017-12-25T15:03:30.0000000+00:00"
}

Changes

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