---
title: "Get All Contacts"
method: GET
path: "/contacts/all"
tags: ["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

- `active` boolean
- `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'
- `persona` string[]
- `sort-order` 'Asc' | 'Desc'
- `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`

Contacts matching the query returned.

- AltoServicesSDKPaginationPagedResponse1AltoContactsApiModelsResponsesContactListItem
  - `meta` AltoServicesSDKPaginationMeta
    - `nextToken` string, nullable
  - `items` AltoContactsApiModelsResponsesContactListItem[], nullable
    - `id` string, nullable: The unique identifier for the resource.
    - `links` AltoApiMaterialHateoasLink[], nullable: Links to related entities.
      - `href` string, nullable
      - `rel` string, nullable
    - `contactType` AltoContactsApiModelsResponsesContactType
      - `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': The Category of the contact
      - `persona` string[], nullable: The Persona(s) of the contact
    - `contactInformation` AltoContactsApiModelsResponsesContactInformation[], nullable: A list of contact information, with one entry per person associated with the contact. Only the first phone number and email address (as recorded in Alto) are included for each person.
      - `title` string, nullable
      - `foreName` string, nullable
      - `surname` string, nullable
      - `phoneNumber` string, nullable
      - `emailAddress` string, nullable
    - `position` string, nullable: The position of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-positions
    - `intention` string, nullable: The intention of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-intentions
    - `disposal` string, nullable: The disposal of the contact, defined as the Id for this AgencyRef chosen from /parameters/client-disposal-status
    - `branch` AltoContactsCoreModelsDomainBranch
      - `id` string, nullable
    - `leadSource` string, nullable: This contact originated from a lead (enquiry)
    - `isActive` boolean: Whether the contact is active or archived.
    - `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.
    - `createdAt` string, date-time: When the contact was created.
    - `modifiedAt` string, date-time: When the contact was last modified.
    - `notes` string, nullable: The notes for the contact.
    - `companyName` string, nullable: The company name associated with the contact.
    - `applicantRequirements` AltoContactsApiModelsResponsesApplicantRequirement[], nullable: The applicant requirements associated with 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` string, nullable
      - `isNewBuild` boolean, nullable
      - `priceFrom` number, double, nullable
      - `priceTo` number, double, nullable
      - `bedsMin` integer, nullable
      - `isActiveProfile` boolean
      - `rentalIntention` AltoContactsApiModelsResponsesRentalIntention
        - `priceQualifier` 'Unknown' | 'Weekly' | 'Monthly' | 'Quarterly' | 'Yearly' | 'AdHoc' | 'Daily' | 'Fortnightly' | 'FourWeekly' | 'MonthlyOnLastDay' | 'QuarterlyOnQuarterDays' | 'HalfYearly' | 'HalfYearlyOnQuarterDays'
        - `furnishing` 'Unspecified' | 'Unfurnished' | 'PartFurnished' | 'Furnished' | 'FurnishedOrUnfurnished', nullable
      - `tenureType` 'Unspecified' | 'Freehold' | 'Leasehold' | 'LeaseholdWithShareOfFreehold' | 'FlyingFreehold' | 'Commonhold' | 'ShareOfFreehold', nullable
      - `notes` string, nullable

## Other responses

- `400`: Invalid 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)