Contacts

Get All Contacts

get/contacts/all

Request

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

Query parameters

activeboolean
Example:true

Filter only active or non-active contacts.

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

Filters contacts by the category of the contact.

personastring[]

Filters contacts by persona within the Contact category of Client. A contact is included in the response if they match any of the specified personas.

sort-order'Asc' | 'Desc'
Example:desc

The order of results by contact id, ascending (oldest first) by default. A <i>next-token</i> can only be used with the sort order it was issued for.

next-tokenstring

The token for the next page of results.

max-resultsinteger

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

created-fromstring date-time

The start date for by created date.

created-tostring date-time

The end date for by created date.

modified-fromstring date-time

The start date for by modified date.

modified-tostring date-time

The end date for by modified date.

Headers

AgencyRefstring required

Response

Contacts matching the query returned.

Example response

{
  "items": [
    {
      "contactType": {
        "category": "\"Client\"",
        "persona": [
          "Landlord",
          "Vendor"
        ]
      },
      "contactInformation": [
        {
          "title": "Mr",
          "foreName": "T",
          "surname": "Potter",
          "phoneNumber": "07972846284",
          "emailAddress": "23705219_test@propertysoftwaregroup.local"
        }
      ],
      "position": "\"In Rented\"",
      "intention": "\"Buy\"",
      "disposal": "\"Not applicable\"",
      "leadSource": "Publication - newspaper",
      "isActive": true,
      "createdAt": "2016-12-14T15:03:30.0000000+00:00",
      "modifiedAt": "2017-12-25T15:03:30.0000000+00:00",
      "companyName": "Acme Corporation"
    }
  ]
}

Changes

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