Skip to main content
GET
/
api
/
v2
/
branches
List branches
curl --request GET \
  --url https://api.example.com/api/v2/branches
[
  {
    "id": "<string>",
    "organisationId": "<string>",
    "branchName": "<string>",
    "registrationNumber": "<string>",
    "sraIDNumber": "<string>",
    "websiteAddress": "<string>",
    "telephoneNumber": "<string>",
    "emailAddress": "<string>",
    "logoUrl": "<string>",
    "address": {
      "line_1": "<string>",
      "line_2": "<string>",
      "line_3": "<string>",
      "post_town": "<string>",
      "county": "<string>",
      "postcode": "<string>",
      "uprn": "<string>"
    },
    "settings": {}
  }
]

Response

List of branches

id
string

Branch ID

organisationId
string

Organisation ID

branchName
string

Branch name

registrationNumber
string | null

Registration number

sraIDNumber
string | null

SRA ID number

websiteAddress
string | null

Website address

telephoneNumber
string | null

Telephone number

emailAddress
string | null

Email address

logoUrl
string | null

Logo URL

address
object

Branch address

settings
object

Branch settings