Alto (Vebra / Zoopla)

Alto (Vebra / Zoopla) Clients API

The Clients API from Alto (Vebra / Zoopla) — 1 operation(s) for clients.

Documentation GitHub OpenAPI

Operations 1

GET /clients This endpoint is now obsolete. Use /contacts endpoint instead #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/alto-vebra-clients-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Alto Clients API
  version: '1.0'
servers:
- url: https://api.alto.zoopladev.co.uk
  description: Sandbox
- url: https://api.alto.zoopla.co.uk
  description: Production
security:
- Bearer: []
tags:
- name: Clients
paths:
  /clients:
    get:
      tags:
      - Clients
      summary: This endpoint is now obsolete. Use /contacts endpoint instead
      parameters:
      - name: clientId
        in: query
        schema:
          type: array
          items:
            type: integer
            format: int32
      - name: AgencyRef
        in: header
        description: A GUID required in the header of all API requests that grants access to an agent's data
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ClientDataItemCollection'
            application/json:
              schema:
                $ref: '#/components/schemas/ClientDataItemCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/ClientDataItemCollection'
        '400':
          description: Bad Request
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
            text/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      deprecated: true
      security:
      - appAuth:
        - alto/route:get-clients
      operationId: getClients
      x-operation-id-source: derived
components:
  schemas:
    Phone:
      type: object
      properties:
        preferenceOrder:
          type: integer
          format: int32
        type:
          type:
          - string
          - 'null'
        description:
          type:
          - string
          - 'null'
        number:
          type:
          - string
          - 'null'
      additionalProperties: false
    Address:
      type: object
      properties:
        subDwelling:
          type:
          - string
          - 'null'
        nameNumber:
          type:
          - string
          - 'null'
        street:
          type:
          - string
          - 'null'
        locality:
          type:
          - string
          - 'null'
        town:
          type:
          - string
          - 'null'
        county:
          type:
          - string
          - 'null'
        postcode:
          type:
          - string
          - 'null'
        countryCode:
          type:
          - string
          - 'null'
        uprn:
          type:
          - string
          - 'null'
      additionalProperties: false
    Name:
      type: object
      properties:
        title:
          type:
          - string
          - 'null'
        forename:
          type:
          - string
          - 'null'
        surname:
          type:
          - string
          - 'null'
      additionalProperties: false
    Person:
      type: object
      properties:
        personNo:
          type: integer
          format: int32
        name:
          allOf:
          - $ref: '#/components/schemas/Name'
        phoneNumbers:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Phone'
        emailAddresses:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EmailAddress'
      additionalProperties: false
    ClientDataItemCollection:
      type: object
      properties:
        items:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ClientData'
      additionalProperties: false
    EmailAddress:
      type: object
      properties:
        preferenceOrder:
          type: integer
          format: int32
        address:
          type:
          - string
          - 'null'
      additionalProperties: false
    ClientData:
      type: object
      properties:
        contactId:
          type: integer
          format: int32
        groupId:
          type: integer
          format: int32
        branchId:
          type: integer
          format: int32
        people:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/Person'
        address:
          allOf:
          - $ref: '#/components/schemas/Address'
      additionalProperties: false
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
        title:
          type:
          - string
          - 'null'
        status:
          type:
          - integer
          - 'null'
          format: int32
        detail:
          type:
          - string
          - 'null'
        instance:
          type:
          - string
          - 'null'
      additionalProperties: {}
  securitySchemes:
    Bearer:
      type: apiKey
      description: Please enter JWT with Bearer into field
      name: Authorization
      in: header