---
title: "Get Branches"
method: GET
path: "/branches"
tags: ["Branches"]
---

# Get Branches

`GET /branches`

## Request

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

Get a paginated list of branches

## Query parameters

- `next-token` string
- `max-results` integer
- `activeOnly` boolean

## Headers

- `AgencyRef` string, required

## Response `200`

Returns a paginated list of branches.

- BranchPagedResponse
  - `meta` Meta
    - `nextToken` string, nullable
    - `previousToken` string, nullable
  - `items` Branch[], nullable
    - `branchId` string, nullable: The ID of the branch.
    - `createdAt` string, date-time, nullable: The date and time the branch was created.
    - `modifiedAt` string, date-time, nullable: The date and time the branch was last modified.
    - `name` string, nullable: The name of the branch.
    - `address` Address
      - `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
    - `status` 'Unknown' | 'Active' | 'Inactive'
    - `defaultMarket` 'Unspecified' | 'Sale' | 'Rent'

## Other responses

- `401`: Unauthorized

---

[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)