List High Earners

curl --request GET \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}",
  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://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}"

	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://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}")

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

{
  "tax_year": 123,
  "total_flagged": 123,
  "items": [
    {
      "employee_identity": {
        "employee_id": "",
        "employee_number": "",
        "full_name": ""
      },
      "gross_figures": {
        "monthly_gross": "0.00",
        "ytd_gross": "0.00",
        "annualized_gross": "0.00"
      },
      "pension_contributions": {
        "monthly_pension_contribution": "0.00",
        "ytd_pension_contribution": "0.00",
        "annual_pension_contribution": "0.00"
      },
      "tax_position": {
        "adjusted_net_income": "0.00",
        "tax_bracket": "BASIC",
        "pa_tapered": "NONE"
      },
      "breach_assessment": {
        "pension_breach": false,
        "cause_of_breach": ""
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "has_next": false,
    "has_prev": false,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "total": 0
  },
  "as_of_tax_month": 123,
  "breach_only": false,
  "advisory_notice": "Advisory only — not an HMRC filing and not a substitute for professional tax advice. Figures are straight-line projections from payroll data for this organisation only: they exclude other employments, non-payroll income, and unused Annual Allowance carried forward from earlier years. Treat every flagged employee as worth a conversation, not as a final liability figure."
}

GET

organizations

{organization_id}

reports

high-earners

{tax_year}

List High Earners

curl --request GET \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}', 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://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}",
  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://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}"

	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://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/reports/high-earners/{tax_year}")

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

{
  "tax_year": 123,
  "total_flagged": 123,
  "items": [
    {
      "employee_identity": {
        "employee_id": "",
        "employee_number": "",
        "full_name": ""
      },
      "gross_figures": {
        "monthly_gross": "0.00",
        "ytd_gross": "0.00",
        "annualized_gross": "0.00"
      },
      "pension_contributions": {
        "monthly_pension_contribution": "0.00",
        "ytd_pension_contribution": "0.00",
        "annual_pension_contribution": "0.00"
      },
      "tax_position": {
        "adjusted_net_income": "0.00",
        "tax_bracket": "BASIC",
        "pa_tapered": "NONE"
      },
      "breach_assessment": {
        "pension_breach": false,
        "cause_of_breach": ""
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "has_next": false,
    "has_prev": false,
    "next_cursor": "<string>",
    "prev_cursor": "<string>",
    "total": 0
  },
  "as_of_tax_month": 123,
  "breach_only": false,
  "advisory_notice": "Advisory only — not an HMRC filing and not a substitute for professional tax advice. Figures are straight-line projections from payroll data for this organisation only: they exclude other employments, non-payroll income, and unused Annual Allowance carried forward from earlier years. Treat every flagged employee as worth a conversation, not as a final liability figure."
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Path Parameters

organization_id

string

required

tax_year

integer

required

Tax year start (2025 = 2025-26)

Required range: 1901 <= x <= 2100

Query Parameters

breach_only

boolean

default:false

Return only employees whose projected pension input exceeds their Annual Allowance.

as_of_tax_month

integer | null

Reproduce the projection as at this tax month. Omitted, each employee's latest snapshot is used.

Required range: 1 <= x <= 12

limit

integer

default:10

Items per page

Required range: 1 <= x <= 100

cursor

string | null

next_cursor of the previous response, for the next page

prev_cursor

string | null

prev_cursor of the previous response, for the page before it. Not together with cursor.

sort

string[]

Fields to order by, - in front for descending (-created_at). Repeat the parameter for more fields. Keep the same sort while following cursors.

Response

Successful Response

Cursor-paginated flagged employees for a tax year (PDR-0004).

The rows are derived on request rather than read from a store, so the cursor page is built in memory, over the same sort order a query would use — the inclusion filter is computed, not a column, and cannot be pushed into SQL.

tax_year

integer

required

total_flagged

integer

required

items

HighEarnerSummaryRow · object[]

required

Show child attributes

pagination

PaginationMeta · object

required

Show child attributes

as_of_tax_month

integer | null

breach_only

boolean

default:false

advisory_notice

string

default:Advisory only — not an HMRC filing and not a substitute for professional tax advice. Figures are straight-line projections from payroll data for this organisation only: they exclude other employments, non-payroll income, and unused Annual Allowance carried forward from earlier years. Treat every flagged employee as worth a conversation, not as a final liability figure.

Core

Great Britain

List High Earners

Authorizations

Path Parameters

Query Parameters

Response