List branches
curl --request GET \
--url https://api.example.com/api/v2/branchesimport requests
url = "https://api.example.com/api/v2/branches"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/branches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/branches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/branches"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v2/branches")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/branches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"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>"
}
}
]{
"message": "<string>"
}Organisations
List branches
Returns a list of branches for the organization.
GET
/
api
/
v2
/
branches
List branches
curl --request GET \
--url https://api.example.com/api/v2/branchesimport requests
url = "https://api.example.com/api/v2/branches"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/branches', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v2/branches",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v2/branches"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/api/v2/branches")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/branches")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body[
{
"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>"
}
}
]{
"message": "<string>"
}Response
List of branches
Branch ID
Organisation ID
Branch name
Registration number
SRA ID number
Website address
Telephone number
Email address
Logo URL
Branch address
Show child attributes
Show child attributes
Was this page helpful?
⌘I