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

# GET /branches

`GET /branches`

Gets a list of all `Branch` objects.

## Headers

- `User-Agent` string
- `If-Modified-Since` string
- `If-None-Match` string

## Response `200`

Successful response with a list of `Branch` data

- object
  - `meta` object, required
    - `LastUpdated` string, date-time, required
    - `TotalResults` integer, required
    - `License` string, uri, required — Open Banking License
    - `TermsOfUse` string, uri, required — Open Banking Terms of Use
  - `data` object[], required
    - `ParentGroupName` string, required — Parent company that owns or partially owns subsidiary organisations.
    - `ParentGroupID` string, required — Unique and unambiguous identification of a financial institution, as assigned under an internationally recognised or proprietary identification scheme
    - `Brand` string, required — maxLength 350 text
    - `BranchName` string — Name by which a party is known and which is usually used to identify that party
    - `BranchIdentification` string, required — Unique and unambiguous identification of a retail branch of a financial institution
    - `BranchType` 'Physical' | 'Mobile', required — Information on the type of branch
    - `Address` object, required — Postal Address
      - `StrtNm` string, required — Name of a street or thoroughfare
      - `BuildingNameOrNumber` string — Number or Name that identifies the position of a building on a street
      - `PstCd` string, required — Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail
      - `OptionalAddressField` string — Additional field; often directions
      - `TwnNm` string — Name of a built-up area, with defined boundaries, and a local government
      - `CtrySubDvsn` string — Identifies a subdivision of a country such as state, region, county
      - `Ctry` string, required — Nation with its own government
    - `BranchDescription` string — Description of the branch
    - `BranchPhoto` string, uri — Image related to the branch
    - `TelephoneNumber` string, required — Collection of information that identifies a phone number, as defined by telecom services.
    - `AlternatePhone` object[]
      - `AlternativeTelephoneNumber` string — Collection of information that identifies a phone number, as defined by telecom services.
      - `AlternativeTelephoneNumberDescription` string — Description of the telephone number
    - `FaxNumber` string[] — Collection of information that identifies a FAX number, as defined by telecom services.
    - `GeographicLocation` object, required — Geographic Coordinates
      - `Lat` string, required — Latitude measured in degrees, minutes and seconds, following by 'N' for North and 'S' for South of the Equator (for example 48°51'29'' N for the Eiffel Tower latitude)
      - `Long` string, required — Angular measurement of the distance of a location on the Earth East or West of the Greenwich Observatory. The longitude is measured in degrees, minutes and seconds, following by 'E' for East and 'W' for West (for example 2°17'4'' E for the Eiffel Tower longitude)
    - `DaysOfTheWeek` integer — Number of days that the mobile branch is available
    - `StopName` string — Name of the stop of the mobile branch
    - `ArrivalTime` string — Arrival time of the mobile branch
    - `DepartureTime` string — Departure time of the mobile branch
    - `ParkingLocation` string — Parking place of the mobile branch
    - `OpeningTimes` object[], required — Branch Opening Times
      - `OpeningDay` 'Monday' | 'Tuesday' | 'Wednesday' | 'Thursday' | 'Friday' | 'Saturday' | 'Sunday' | 'Public and Bank Holiday', required — Day of the week
      - `OpeningTime` string, required — Time Definition HH:MM:SS
      - `ClosingTime` string, required — Time Definition HH:MM:SS
      - `UnavailableStartTime` string — Time Definition HH:MM:SS
      - `UnavailableFinishTime` string — Time Definition HH:MM:SS
    - `PlannedBranchClosure` array[]
      - object[] — Planned branch closure
        - `StartDate` string, required — Date when a branch is due to close temporarily or permanently
        - `EndDate` string, required — Date when a branch is due to re-open following temporary closure
    - `AccessibilityTypes` string[] — Information about the accessibility
    - `BranchSelfServeServiceName` string[]
    - `BranchSelfServeServiceDescription` string[] — Additional information about self service branch services
    - `BranchMediatedServiceName` string[] — Information about mediated branch facilities
    - `BranchMediatedServiceDescription` string[] — Additional information about mediated branch facilities, such as waiting areas with seats available for business banking (if waiting)
    - `BranchFacilitiesName` string[] — Information about branch facilities
    - `CustomerSegment` string[] — Customer segment which the branch is able to service
    - `BranchFacilitiesDescription` string[] — Additional information about branch facilities, such as specific lights
    - `ATMAtBranch` boolean, required — Indicated whether an ATM is at the branch

## Other responses

- `400` — You have sent a request which could not be understood.
- `408` — Your client has failed to submit a request, and a timeout has occurred.
- `429` — You have requested this resource too often. Slow down.
- `500` — An error occurred on the server. No further information is available.
- `503` — The service is temporarily unavailable.
- `default` — A standard error response.

---

[API](https://skmtc.dev/openbankinguk/apis/open-data-api.md) · [All operations](https://skmtc.dev/openbankinguk/apis/open-data-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/openbankinguk/open-data-api/revisions/f25ce98e62b1/schema)