---
title: "Get Branch By Id"
method: GET
path: "/branches/{branchId}"
tags: ["Branches"]
---

# Get Branch By Id

`GET /branches/{branchId}`

## Request

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

## Path parameters

- `branchId` string, required

## Headers

- `AgencyRef` string, required

## Response `200`

Returns the branch.

- Branch: Represents a branch.
  - `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

- `400`: When the request does not contain the expected information.
- `401`: When access to the branch has not been granted.
- `404`: When the branch is not found.

---

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