Get Job

Get Job

curl --request GET \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job"

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

	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))

}

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job")

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

{
  "edition": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "start_date": "2023-12-25",
  "contracted_weekly_hours": 40,
  "department": "<string>",
  "contracted_weekdays": [
    "Monday"
  ],
  "worker_type": "EMPLOYEE",
  "director_since": "2023-12-25",
  "pay_basis": "SALARIED",
  "apprenticeship": {
    "start_date": "2023-12-25",
    "level": 4,
    "expected_end_date": "2023-12-25"
  },
  "p45_issued": false,
  "irregular_payment_pattern": false,
  "ordinarily_works_in_uk": true,
  "proration_basis": {
    "mode": "CALENDAR_DAY",
    "business_days_per_year": "<string>"
  },
  "end_date": "2023-12-25"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

GET

organizations

{organization_id}

employees

{employee_id}

job

Get Job

curl --request GET \
  --url https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job"

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

	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))

}

require 'uri'
require 'net/http'

url = URI("https://preview.intermezzo.ai/gb/organizations/{organization_id}/employees/{employee_id}/job")

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

{
  "edition": 123,
  "valid_from": "2023-12-25",
  "valid_to": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "start_date": "2023-12-25",
  "contracted_weekly_hours": 40,
  "department": "<string>",
  "contracted_weekdays": [
    "Monday"
  ],
  "worker_type": "EMPLOYEE",
  "director_since": "2023-12-25",
  "pay_basis": "SALARIED",
  "apprenticeship": {
    "start_date": "2023-12-25",
    "level": 4,
    "expected_end_date": "2023-12-25"
  },
  "p45_issued": false,
  "irregular_payment_pattern": false,
  "ordinarily_works_in_uk": true,
  "proration_basis": {
    "mode": "CALENDAR_DAY",
    "business_days_per_year": "<string>"
  },
  "end_date": "2023-12-25"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Get token from Auth0 and paste it here

Path Parameters

organization_id

string

required

employee_id

string

required

Query Parameters

valid_at

string<date> | null

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

edition

integer

required

read-only

valid_from

string<date>

required

valid_to

string<date>

required

created_at

string<date-time>

required

read-only

created_by

string

required

read-only

Who wrote the edition: 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.

start_date

string<date> | null

Employment start date

contracted_weekly_hours

integer | null

default:40

Contracted weekly hours

department

string | null

Department

contracted_weekdays

enum<string>[] | null

Contracted working days of the week

Required array length: 1 - 7 elements

Days of the week.

Available options:

Monday,

Tuesday,

Wednesday,

Thursday,

Friday,

Saturday,

Sunday

worker_type

enum<string>

default:EMPLOYEE

UK employment status (employee, worker, director)

Available options:

EMPLOYEE,

DIRECTOR

director_since

string<date> | null

Date appointed as director (None if not a director)

pay_basis

enum<string>

default:SALARIED

How pay and hours are determined

Available options:

SALARIED,

HOURLY

apprenticeship

Apprenticeship · object | null

Apprenticeship details (None = not an apprentice)

Show child attributes

p45_issued

boolean

default:false

True once a P45 has been issued for this employment (post-cessation). Drives the weekly NIC earnings period for post-P45 payments. Distinct from the inbound-starter p45_gross_pay/p45_tax_amount in tax, which carry a new joiner's prior-employer figures.

irregular_payment_pattern

boolean

default:false

The employee is not paid every pay period (casual, seasonal, annual director pay). Reported to HMRC as IrrEmp so the employment is not treated as ceased after a run of periods without payment.

ordinarily_works_in_uk

boolean

default:true

Whether the worker's ordinary place of work under their contract is in the UK (per TPR Detailed Guidance No. 1). If False, the employer has no statutory auto-enrolment duties for this worker. Employees on temporary overseas secondment who remain on UK payroll and whose ordinary place of work is the UK stay True: this flag reflects the contractual base, not the employee's current physical location.

proration_basis

ProrationBasis · object | null

Employee-level override of the inherited proration basis

Show child attributes

end_date

string<date> | null

Last day of employment

Core

Great Britain

Authorizations

Path Parameters

Query Parameters

Response