GET
/
gb
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
pension
/
assessments
Get auto-enrolment assessments
curl --request GET \
  --url https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/assessments \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/assessments"

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}/employees/{employee_id}/pension/assessments', 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}/employees/{employee_id}/pension/assessments",
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}/employees/{employee_id}/pension/assessments"

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}/employees/{employee_id}/pension/assessments")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://dev.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/pension/assessments")

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
[
  {
    "assessment_date": "2023-12-25",
    "enrolment_required": true,
    "re_enrolment_indicator": true,
    "qualifying_earnings": "<string>",
    "age_at_assessment": 123,
    "payrun_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
]
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

Get token from Auth0 and paste it here

Path Parameters

organization_id
required
employee_id
required

Response

Successful Response

assessment_date
string<date>
required

Date of the assessment; equals the pay_date from the pay calendar

worker_category
enum<string>
required

AE worker category determined by the system on this date based on age and earnings: ELIGIBLE_JOBHOLDER, NON_ELIGIBLE_JOBHOLDER, ENTITLED_WORKER, or EXCLUDED

Available options:
ELIGIBLE_JOBHOLDER,
NON_ELIGIBLE_JOBHOLDER,
ENTITLED_WORKER,
EXCLUDED
eligibility_trigger
enum<string>
required

What initiated this assessment: NEW_HIRE (first payrun for this employee), EARNINGS_THRESHOLD (earnings crossed the trigger for the first time), AGE_THRESHOLD (employee turned 22), RE_ENROLMENT (3-year cyclical re-enrolment), PAY_PERIOD_ASSESSMENT (routine check on every payrun)

Available options:
NEW_HIRE,
EARNINGS_THRESHOLD,
AGE_THRESHOLD,
RE_ENROLMENT,
PAY_PERIOD_ASSESSMENT
enrolment_required
boolean
required

True if the employee was eligible and not yet enrolled — auto_enrol() was called and the employee was enrolled into the default scheme. False if already ACTIVE, not eligible, or on postponement

re_enrolment_indicator
boolean
required

True if this was a cyclical re-enrolment (employee had previously opted out and is being re-enrolled under the 3-year duty); false for initial enrolment

qualifying_earnings
string | null
required

Earnings within the AE qualifying band (£6,240–£50,270/year, pro-rated for the period) used as the contribution base; null if the employee was not eligible or contributions were not calculated

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
age_at_assessment
integer | null
required

Employee's age in whole years on the assessment date; null if date of birth was unavailable

payrun_id
string | null
required

ID of the payrun in which this assessment was performed; null for assessments triggered outside a payrun (e.g. manual enrolment)

created_at
string<date-time>
required

Timestamp when this assessment record was created