curl --request GET \
--url https://dev.intermezzo.ai/gb/organizations/{organization_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}', 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://dev.intermezzo.ai/gb/organizations/{organization_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://dev.intermezzo.ai/gb/organizations/{organization_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.intermezzo.ai/gb/organizations/{organization_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"client_id": "<string>",
"country_code": "GB",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"external_ref": "<string>",
"id": "<string>",
"status": {},
"address": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"address": "<string>",
"correspondence_address": "<string>"
},
"bank": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"accounts": [
{
"account_number": "<string>",
"financial_institution_name": "<string>",
"is_active": true,
"is_primary": false,
"sort_code": "<string>"
}
],
"bacs_service_user_number": "<string>"
},
"contact": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"contacts": [
{
"name": "Jane Smith",
"email": "<string>",
"is_primary": false,
"phone": {
"phone_number": "<string>",
"phone_type": "MOBILE"
},
"roles": [
"<string>"
]
}
],
"hmrc_sender_email": "<string>"
},
"core": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"dba_name": "<string>",
"incorporation_date": "2023-12-25",
"legal_name": "<string>",
"logo_id": "<string>",
"shutdown_date": "2023-12-25",
"website": "<string>"
},
"insurance": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"employment_allowance_eligible": false
},
"tax": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"accounts_office_reference": "<string>",
"corporation_tax_reference": "<string>",
"paye_reference_number": "<string>"
}
}{
"errors": [
{
"code": "HUB_NOT_FOUND",
"message": "Raised when a hub does not exist under the parent named in the path."
}
]
}{
"errors": [
{
"code": "FIELD_REQUIRED",
"message": "<string>",
"field": "<string>",
"params": {}
}
]
}Get Organization
curl --request GET \
--url https://dev.intermezzo.ai/gb/organizations/{organization_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://dev.intermezzo.ai/gb/organizations/{organization_id}', 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://dev.intermezzo.ai/gb/organizations/{organization_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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://dev.intermezzo.ai/gb/organizations/{organization_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://dev.intermezzo.ai/gb/organizations/{organization_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"client_id": "<string>",
"country_code": "GB",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"deleted_at": "2023-11-07T05:31:56Z",
"external_ref": "<string>",
"id": "<string>",
"status": {},
"address": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"address": "<string>",
"correspondence_address": "<string>"
},
"bank": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"accounts": [
{
"account_number": "<string>",
"financial_institution_name": "<string>",
"is_active": true,
"is_primary": false,
"sort_code": "<string>"
}
],
"bacs_service_user_number": "<string>"
},
"contact": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"contacts": [
{
"name": "Jane Smith",
"email": "<string>",
"is_primary": false,
"phone": {
"phone_number": "<string>",
"phone_type": "MOBILE"
},
"roles": [
"<string>"
]
}
],
"hmrc_sender_email": "<string>"
},
"core": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"dba_name": "<string>",
"incorporation_date": "2023-12-25",
"legal_name": "<string>",
"logo_id": "<string>",
"shutdown_date": "2023-12-25",
"website": "<string>"
},
"insurance": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"employment_allowance_eligible": false
},
"tax": {
"created_at": "2023-11-07T05:31:56Z",
"created_by": "<string>",
"edition": 123,
"valid_from": "2023-12-25",
"valid_to": "2023-12-25",
"accounts_office_reference": "<string>",
"corporation_tax_reference": "<string>",
"paye_reference_number": "<string>"
}
}{
"errors": [
{
"code": "HUB_NOT_FOUND",
"message": "Raised when a hub does not exist under the parent named in the path."
}
]
}{
"errors": [
{
"code": "FIELD_REQUIRED",
"message": "<string>",
"field": "<string>",
"params": {}
}
]
}Authorizations
Get token from Auth0 and paste it here
Path Parameters
Query Parameters
Valid-time date to read, past or future. Defaults to today, or to the first upcoming edition when nothing is valid yet.
Response
Successful Response
The organization with every satellite as it reads on one date. A satellite never written, or with no slice on an explicit date, is null.
"GB"Who created the hub: the acting user (X-Acting-User, else the access credential), system for our own writes, or <authority>:<notice> for a write on an authority's behalf, e.g. hmrc:P6.
When the hub was closed
The read-only status satellite. It carries no fields; it exists so that every
organization read has a status object.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes