POST
/
organizations
/
{organization_id}
/
employees
/
{employee_id}
/
job-details
Create Employee Job Details
curl --request POST \
  --url https://api.example.com/organizations/{organization_id}/employees/{employee_id}/job-details \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "employmentCountry": "GB",
  "jobType": "Full Time Indefinite Term",
  "employmentStatus": "Employee",
  "jobTitle": "Software Engineer",
  "jobDescription": "<string>",
  "contractedWeeklyHours": 40,
  "worksiteId": "<string>",
  "department": "<string>",
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25"
}
'
{
  "id": 123,
  "employeeId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "employmentCountry": "GB",
  "jobType": "Full Time Indefinite Term",
  "employmentStatus": "Employee",
  "jobTitle": "<string>",
  "jobDescription": "<string>",
  "contractedWeeklyHours": 40,
  "worksiteId": "<string>",
  "department": "<string>",
  "validFrom": "2023-12-25",
  "validTo": "2023-12-25"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
organization_id
required
​
employee_id
required

Body

application/json

Schema for job-related data of a UK employee. Supports both standalone and integrated requests.

​
employmentCountry
string
default:GB
Allowed value: "GB"
​
jobType
enum<string> | null

Employment type

Available options:
Full Time Indefinite Term,
Full Time Fixed Term,
Part Time Indefinite Term,
Part Time Fixed Term
​
employmentStatus
enum<string> | null

Employee Status

Available options:
Employee,
Worker,
Director
​
jobTitle
string | null

Job title

Example:

"Software Engineer"

​
jobDescription
string | null

Job description

​
contractedWeeklyHours
integer | null
default:40

Contracted weekly hours

​
worksiteId

Work location

​
department
string | null

Department

​
validFrom
string<date>

Valid from date

​
validTo
string<date> | null

Valid to date

Response

Successful Response

Response model for job details with metadata fields.

​
id
required
​
employeeId
string
required
​
createdAt
string<date-time> | null
required
​
updatedAt
string<date-time> | null
required
​
employmentCountry
string
default:GB
Allowed value: "GB"
​
jobType
enum<string> | null

Employment types recognized in Germany.

Available options:
Full Time Indefinite Term,
Full Time Fixed Term,
Part Time Indefinite Term,
Part Time Fixed Term
​
employmentStatus
enum<string> | null

Employee types recognized in Germany.

Available options:
Employee,
Worker,
Director
​
jobTitle
string | null
​
jobDescription
string | null
​
contractedWeeklyHours
integer | null
default:40
​
worksiteId
string | null
​
department
string | null
​
validFrom
string<date>

Valid from date

​
validTo
string<date> | null

Valid to date