GET
Get Job

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

pay_group_id
string | null

The pay group the employee is paid in

contracted_weekdays
enum<string>[] | null

Contracted working days of the week

Days of the week.

Available options:
MONDAY,
TUESDAY,
WEDNESDAY,
THURSDAY,
FRIDAY,
SATURDAY,
SUNDAY
worker_type
enum<string>
default:EMPLOYEE

UK employment status

Available options:
EMPLOYEE,
DIRECTOR
director_since
string<date> | null

Date appointed as director

pay_basis
enum<string>
default:SALARIED

How pay and hours are determined

Available options:
SALARIED,
HOURLY
apprenticeship
Apprenticeship · object | null

Apprenticeship details

p45_issued
boolean
default:false

True once a P45 has been issued

irregular_payment_pattern
boolean
default:false

The employee is not paid every pay period

ordinarily_works_in_uk
boolean
default:true

Whether the worker's ordinary place of work is in the UK

uk_work_exclusion_reason
enum<string>
default:NOT_APPLICABLE

Why the worker does not ordinarily work in the UK

Available options:
NOT_APPLICABLE,
OVERSEAS_CONTRACT,
OUTBOUND_POSTING,
INBOUND_TEMPORARY_POSTING,
MOBILE_WORKER_OVERSEAS_BASE,
OTHER
proration_basis
ProrationBasis · object | null

Employee-level override of the inherited proration basis

end_date
string<date> | null

Last day of employment