List introducers
curl --request GET \
--url https://api.example.com/api/v2/introducersimport requests
url = "https://api.example.com/api/v2/introducers"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/introducers', 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/introducers",
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/introducers"
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/introducers")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/introducers")
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": 123,
"name": "<string>",
"mainContactName": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"address": {
"line_1": "<string>",
"line_2": "<string>",
"line_3": "<string>",
"post_town": "<string>",
"county": "<string>",
"postcode": "<string>",
"uprn": "<string>"
}
}
]Organisations
List introducers
Returns a list of introducers for the organisation. Use the id field when creating a case with an associated introducer.
GET
/
api
/
v2
/
introducers
List introducers
curl --request GET \
--url https://api.example.com/api/v2/introducersimport requests
url = "https://api.example.com/api/v2/introducers"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/api/v2/introducers', 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/introducers",
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/introducers"
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/introducers")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v2/introducers")
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": 123,
"name": "<string>",
"mainContactName": "<string>",
"emailAddress": "<string>",
"phoneNumber": "<string>",
"address": {
"line_1": "<string>",
"line_2": "<string>",
"line_3": "<string>",
"post_town": "<string>",
"county": "<string>",
"postcode": "<string>",
"uprn": "<string>"
}
}
]Response
200 - application/json
List of introducers
Introducer ID — pass this as introducerId when creating a case
Introducer name
Name of the main contact at the introducer
Email address of the introducer
Phone number of the introducer
Introducer address
Show child attributes
Show child attributes
Was this page helpful?
⌘I