---
title: "Search All Contacts"
method: GET
path: "/contacts/search"
tags: ["Contacts"]
---

# Search All Contacts

`GET /contacts/search`

## Request

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

Search for all matching contacts and return a paginated list of results.

## Query parameters

- `query` string, required
- `archived` boolean
- `contact-type` 'Unknown' | 'Client' | 'Solicitor' | 'BuildingSociety' | 'Bank' | 'Publication' | 'EstateAgent' | 'ManagingAgent' | 'Developer' | 'Builder' | 'Utility' | 'Service' | 'PreviousClient' | 'Miscellaneous' | 'FinancialAdvisor' | 'Maintenance' | 'OnSiteSales' | 'ExternalPrinter' | 'OtherCategory1' | 'EstateAgentLocal' | 'Surveyor' | 'Supplier' | 'Accountant'
- `next-token` string
- `max-results` integer
- `created-from` string, date-time
- `created-to` string, date-time
- `modified-from` string, date-time
- `modified-to` string, date-time

## Headers

- `AgencyRef` string, required

## Response `200`

OK

- AltoServicesSDKPaginationPagedResponse1AltoContactsApiModelsResponsesContactSearchItemResponse
  - `meta` AltoServicesSDKPaginationMeta
    - `nextToken` string, nullable
  - `items` AltoContactsApiModelsResponsesContactSearchItemResponse[], nullable
    - `id` string, nullable: The unique identifier for the resource.
    - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities.
      - `href` string, nullable
      - `rel` string, nullable
    - `contactId` string, nullable: The unique identifier for the contact.
    - `displayName` string, nullable: The display name for the contact.
    - `branchId` integer: The identifier of the branch that owns the contact.
    - `archived` boolean: Indicates whether the contact is archived or not.
    - `potentialVendor` boolean: Indicates whether the contact has been flagged as a potential vendor.
    - `potentialLandlord` boolean: Indicates whether the contact has been flagged as a potential landlord.
    - `notes` string, nullable: The notes for the contact.
    - `category` 'Unknown' | 'Client' | 'Solicitor' | 'BuildingSociety' | 'Bank' | 'Publication' | 'EstateAgent' | 'ManagingAgent' | 'Developer' | 'Builder' | 'Utility' | 'Service' | 'PreviousClient' | 'Miscellaneous' | 'FinancialAdvisor' | 'Maintenance' | 'OnSiteSales' | 'ExternalPrinter' | 'OtherCategory1' | 'EstateAgentLocal' | 'Surveyor' | 'Supplier' | 'Accountant': The category type of the contact.
    - `registeredOn` string, date-time, nullable: The date and time when the contact was registered.
    - `lastContactedOn` string, date-time, nullable: The date and time when the contact was last contacted.
    - `address` AltoServicesSDKModelsAddress
      - `subDwelling` string, nullable
      - `nameNumber` string, nullable
      - `street` string, nullable
      - `locality` string, nullable
      - `town` string, nullable
      - `county` string, nullable
      - `postcode` string, nullable
      - `countryCode` string, nullable
      - `uprn` string, nullable
    - `people` AltoContactsApiModelsResponsesContactSearchPersonResponse[], nullable: People associated to the contact.
      - `personId` string, nullable: The unique identifier for the person within the contact.
      - `title` string, nullable: The formal title of the Person.
      - `forename` string, nullable: The first or given name of the Person.
      - `surname` string, nullable: The surname of the Person.
      - `emails` AltoContactsApiModelsResponsesContactSearchEmailResponse[], nullable: The email addresses for the Person.
        - `emailAddressId` string, nullable: The unique identifier for the email address.
        - `emailAddress` string, nullable: The email address for the person.
      - `phoneNumbers` AltoContactsApiModelsResponsesContactSearchPhoneResponse[], nullable: The phone numbers for the Person.
        - `phoneNumberId` string, nullable: The unique identifier for the phone number.
        - `phoneNumber` string, nullable: The telephone number for the Person.
        - `type` 'Unspecified' | 'Home' | 'Business' | 'Mobile' | 'Fax' | 'Work' | 'ISDN', nullable
    - `properties` AltoContactsApiModelsResponsesContactSearchPropertyResponse[], nullable: Properties owned by the contact.
      - `id` string, nullable: The unique identifier for the resource.
      - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities.
        - `href` string, nullable
        - `rel` string, nullable
      - `propertyId` string, nullable: The unique identifier for the property.
      - `displayAddress` string, nullable: The display address for the property.
      - `market` 'Unspecified' | 'Sale' | 'Rent': The market type for the property.
    - `applicantRequirements` AltoContactsApiModelsResponsesContactSearchApplicantRequirementResponse[], nullable: Applicant requirements for the contact.
      - `id` string, nullable: The unique identifier for the resource.
      - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities.
        - `href` string, nullable
        - `rel` string, nullable
      - `profileIntention` 'Unspecified' | 'Buy' | 'Rent'
      - `isNewBuild` boolean, nullable
      - `priceFrom` integer, nullable
      - `priceTo` integer, nullable
      - `bedsMin` integer, nullable
      - `isActiveProfile` boolean
      - `rentalIntention` AltoContactsApiModelsResponsesContactSearchRentalIntention
        - `priceQualifier` 'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays'
        - `furnishing` 'Unspecified' | 'Unfurnished' | 'PartFurnished' | 'Furnished' | 'FurnishedOrUnfurnished', nullable
    - `modifiedDate` string, date-time, nullable: The date and time when the contact was last modified.

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/alto/apis/alto-api.md) - [All operations](https://skmtc.dev/alto/apis/alto-api/llms.txt) - [OpenAPI document](https://skmtc.dev/alto/apis/alto-api/revisions/1b729d9b15a8?raw)