Read intelliHR people, jobs, leave, skills and training; create and update people records.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: record extended leave (parental, long service, unpaid, etc.) on an existing job. It changes the person's employment record and can trigger intelliHR workflows. The leave is created with the end date you give as expected; finalise it in intelliHR when the person returns. Find leave types with list_reference_data kind extended_leave_types. POST /extended-leave.
The job the leave belongs to.
Expected end date, yyyy-mm-dd.
FTE during the leave, e.g. 0.6.
Extended leave type id.
Extended leave type name (used when no id is given).
This tool isn't marked read-only, so it may change something on the server or in an account you connected.
WRITE: record extended leave (parental, long service, unpaid, etc.) on an existing job. It changes the person's employment record and can trigger intelliHR workflows. The leave is created with the end date you give as expected; finalise it in intelliHR when the person returns. Find leave types with list_reference_data kind extended_leave_types. POST /extended-leave.
| Argument | Type | Description |
|---|---|---|
| fte | string | FTE during the leave, e.g. 0.6. |
| job_id* | string | The job the leave belongs to. |
| end_date* | string | Expected end date, yyyy-mm-dd. |
| start_date* | string | |
| leave_type_id | string | Extended leave type id. |
| leave_type_name | string | Extended leave type name (used when no id is given). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id",
"start_date",
"end_date"
],
"properties": {
"fte": {
"type": "string",
"pattern": "^\\d+(\\.\\d+)?$",
"description": "FTE during the leave, e.g. 0.6."
},
"job_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "The job the leave belongs to."
},
"end_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "Expected end date, yyyy-mm-dd."
},
"start_date": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$"
},
"leave_type_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "Extended leave type id."
},
"leave_type_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Extended leave type name (used when no id is given)."
}
}
}WRITE: create a new person record in intelliHR (last name required). It creates the person only: no job, no user account and no welcome email is sent. A job is added separately in intelliHR. Check with list_people first to avoid duplicates. POST /people.
| Argument | Type | Description |
|---|---|---|
| string | Primary email address. | |
| phone | string | Primary phone number. |
| title | string | For example Mr, Ms, Dr. |
| gender | string | |
| last_name* | string | |
| first_name | string | |
| middle_name | string | |
| date_of_birth | string | yyyy-mm-dd. |
| preferred_name | string | |
| employee_number | string | |
| email_is_personal |
One job by id with its person, position title, location, business unit, supervisor, pay grade, remuneration and dates. GET /jobs/{id}.
| Argument | Type | Description |
|---|---|---|
| job_id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}The upcoming changes and current information about a job (scheduled changes, end date). GET /jobs/{jobId}/timeline.
| Argument | Type | Description |
|---|---|---|
| job_id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"job_id"
],
"properties": {
"job_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}One person's full record by id: names, date of birth, gender, employee number, contact details, addresses, emergency contact, employment status, jobs, work rights, user account and custom fields. Health information is never returned. GET /people/{id}.
| Argument | Type | Description |
|---|---|---|
| person_id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"person_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}The organisation's business entities (legal employers). GET /business-entities.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}The organisation's business units (departments, teams). Filter by name or identifier. GET /business-units.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the business unit name. |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
| identifier | string | The customer identifier of the unit. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Part of the business unit name."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"identifier": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The customer identifier of the unit."
}
}
}The custom fields defined in intelliHR (what each field on a person, job or location means and its type). GET /custom-field-definitions.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}List jobs (roles people hold, past, current and future) as at today: person, position title, location, business unit and entity, supervisor, work type, FTE, remuneration schedule, start/end dates and status. Filter by person, job title, status (Current Job, Future Job, Ending Job, Past Job), work type, primary job, or upcoming/recent end dates. GET /jobs.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| string | The holder's primary email. | |
| limit | integer | Results per page, 1-100 (default 25). |
| job_id | string | One UUID, or several separated by commas. |
| status | string | |
| job_name | string | The job (position title) name. |
| person_id | string | Person id(s), comma separated: the jobs of those people. |
| work_type | string | Work type name, e.g. Fixed Contract. |
| person_name |
The organisation's locations (sites) with parent location, code, address, enabled flag and representatives. GET /locations.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}The pay grades and their rates, optionally as at a date. GET /pay-grades.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| as_at | string | Show the pay grades as at this point in time: an RFC3339 datetime (2026-10-01T09:00:00+10:00) or a date yyyy-mm-dd (= 00:00 UTC that day). Default now. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"as_at": {
"type": "string",
"description": "Show the pay grades as at this point in time: an RFC3339 datetime (2026-10-01T09:00:00+10:00) or a date yyyy-mm-dd (= 00:00 UTC that day). Default now."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}List the people (employees) in intelliHR as at today: name, employee number, email, phone, addresses, emergency contact, employment status, their jobs (summary) and custom fields. Filter by name (matches any part of the name), email, employee number, job id, recently updated, or who is on extended leave. Health information is never returned. GET /people.
| Argument | Type | Description |
|---|---|---|
| name | string | Match any part of a person's name (case-insensitive, any name order). |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| string | Exact primary email address. | |
| limit | integer | Results per page, 1-100 (default 25). |
| job_id | string | Current job id(s), comma separated: the people who hold them. |
| newest_first | boolean | Sort by creation date, newest first (default: API order). |
| employee_number | string | Exact employee number. |
| on_extended_leave | boolean | true = only people on extended leave, false = only people not on extended leave. |
The documents stored on a person's record (file name, type, size, upload status and a download link). Contents are not read. GET /people/{personId}/documents.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
| person_id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"person_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}The skills assigned to a person (with their level and review details as intelliHR returns them). The whole list comes back at once. GET /people/{personId}/skills.
| Argument | Type | Description |
|---|---|---|
| person_id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"person_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}Tasks (forms, reviews, check-ins, onboarding steps) for a person, by tab: DUE (default), ABOUT_ME, ABOUT_OTHERS, DONE or IGNORED. GET /people/{personId}/tasks.
| Argument | Type | Description |
|---|---|---|
| tab | string | Which tab of tasks (default DUE). |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
| person_id* | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"tab": {
"enum": [
"DUE",
"ABOUT_ME",
"ABOUT_OTHERS",
"DONE",
"IGNORED"
],
"type": "string",
"description": "Which tab of tasks (default DUE)."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"person_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}The position titles (job names) defined in intelliHR. Filter by name. GET /position-titles.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the position title. |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Part of the position title."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}Qualification records held by people (licences, certificates) with status and dates. Filter by person, employee number or library item. GET /qualifications.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
| person_id | string | Person id(s), comma separated. |
| employee_number | string | |
| qualification_library_item_id | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"person_id": {
"type": "string",
"description": "Person id(s), comma separated."
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"qualification_library_item_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}Look up one of intelliHR's reference lists: employment_conditions, work_classes, work_types, work_rights, recruitment_sources, extended_leave_types, job_change_reasons, skill_disciplines, training_types, training_providers, qualification_types, qualification_library_items, onboarding_templates, permission_groups or representative_types. Use it to find the ids and names other tools need.
| Argument | Type | Description |
|---|---|---|
| kind* | string | |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"kind"
],
"properties": {
"kind": {
"enum": [
"employment_conditions",
"work_classes",
"work_types",
"work_rights",
"recruitment_sources",
"extended_leave_types",
"job_change_reasons",
"skill_disciplines",
"training_types",
"training_providers",
"qualification_types",
"qualification_library_items",
"onboarding_templates",
"permission_groups",
"representative_types"
],
"type": "string"
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}The skills catalogue, optionally only business-critical skills or one discipline. GET /skills.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
| discipline_id | string | Only skills in this skill discipline (see list_reference_data kind skill_disciplines). |
| business_critical | boolean | true = only business-critical skills. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"discipline_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
"description": "Only skills in this skill discipline (see list_reference_data kind skill_disciplines)."
},
"business_critical": {
"type": "boolean",
"description": "true = only business-critical skills."
}
}
}Training records completed or booked by people, with provider, type and dates. Filter by training name, provider, type, employee number or email. GET /trainings.
| Argument | Type | Description |
|---|---|---|
| name | string | Training name. |
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| string | The person's primary email. | |
| limit | integer | Results per page, 1-100 (default 25). |
| type_name | string | |
| newest_first | boolean | Sort by creation date, newest first. |
| provider_name | string | |
| employee_number | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Training name."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "The person's primary email."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"type_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"newest_first": {
"type": "boolean",
"description": "Sort by creation date, newest first."
},
"provider_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
}
}
}The user accounts that can sign in to intelliHR: username, enabled flag, permission groups and the linked person. GET /users.
| Argument | Type | Description |
|---|---|---|
| page | integer | Page number, from 1 (default 1). Pass the previous reply's next_page. |
| limit | integer | Results per page, 1-100 (default 25). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
}
}
}WRITE: change fields on an existing person (only the fields you pass change): names, date of birth, gender, employee number, title and emergency contact. Contact details, addresses and jobs are not changed by this tool. PATCH /people/{id}.
| Argument | Type | Description |
|---|---|---|
| title | string | For example Mr, Ms, Dr. |
| gender | string | |
| last_name | string | |
| person_id* | string | |
| first_name | string | |
| middle_name | string | |
| date_of_birth | string | yyyy-mm-dd. |
| preferred_name | string | |
| employee_number | string | |
| emergency_contact | object | Emergency contact details to set. |
| boolean |
| true if the email is personal rather than a work address (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"last_name"
],
"properties": {
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Primary email address."
},
"phone": {
"type": "string",
"maxLength": 40,
"minLength": 3,
"description": "Primary phone number."
},
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "For example Mr, Ms, Dr."
},
"gender": {
"enum": [
"Female",
"Male",
"Non-binary",
"Other",
"Undisclosed"
],
"type": "string"
},
"last_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"first_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"middle_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"date_of_birth": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "yyyy-mm-dd."
},
"preferred_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"email_is_personal": {
"type": "boolean",
"description": "true if the email is personal rather than a work address (default false)."
}
}
}| string |
| The holder's name. |
| newest_first | boolean | Sort by creation date, newest first. |
| primary_only | boolean | true = only primary jobs, false = only non-primary jobs. |
| employee_number | string | The holder's employee number. |
| ended_within_days | integer | Jobs that ended in the last N days (including today). |
| ending_within_days | integer | Jobs with an end date in the next N days (including today). |
| updated_within_days | integer |
| employment_condition_id | string |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "The holder's primary email."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"job_id": {
"type": "string",
"description": "One UUID, or several separated by commas."
},
"status": {
"enum": [
"Current Job",
"Future Job",
"Ending Job",
"Past Job"
],
"type": "string"
},
"job_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The job (position title) name."
},
"person_id": {
"type": "string",
"description": "Person id(s), comma separated: the jobs of those people."
},
"work_type": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Work type name, e.g. Fixed Contract."
},
"person_name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The holder's name."
},
"newest_first": {
"type": "boolean",
"description": "Sort by creation date, newest first."
},
"primary_only": {
"type": "boolean",
"description": "true = only primary jobs, false = only non-primary jobs."
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "The holder's employee number."
},
"ended_within_days": {
"type": "integer",
"maximum": 36500,
"minimum": 0,
"description": "Jobs that ended in the last N days (including today)."
},
"ending_within_days": {
"type": "integer",
"maximum": 36500,
"minimum": 0,
"description": "Jobs with an end date in the next N days (including today)."
},
"updated_within_days": {
"type": "integer",
"maximum": 36500,
"minimum": 0
},
"employment_condition_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
}
}
}| updated_within_days | integer | Only people updated within this many days. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Match any part of a person's name (case-insensitive, any name order)."
},
"page": {
"type": "integer",
"maximum": 100000,
"description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
"exclusiveMinimum": 0
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 3,
"description": "Exact primary email address."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"job_id": {
"type": "string",
"description": "Current job id(s), comma separated: the people who hold them."
},
"newest_first": {
"type": "boolean",
"description": "Sort by creation date, newest first (default: API order)."
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Exact employee number."
},
"on_extended_leave": {
"type": "boolean",
"description": "true = only people on extended leave, false = only people not on extended leave."
},
"updated_within_days": {
"type": "integer",
"maximum": 36500,
"minimum": 0,
"description": "Only people updated within this many days."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"title": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "For example Mr, Ms, Dr."
},
"gender": {
"enum": [
"Female",
"Male",
"Non-binary",
"Other",
"Undisclosed"
],
"type": "string"
},
"last_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"person_id": {
"type": "string",
"pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
},
"first_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"middle_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"date_of_birth": {
"type": "string",
"pattern": "^(\\d{4})-(\\d{2})-(\\d{2})$",
"description": "yyyy-mm-dd."
},
"preferred_name": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"employee_number": {
"type": "string",
"maxLength": 200,
"minLength": 1
},
"emergency_contact": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 200
},
"email": {
"type": "string",
"maxLength": 254
},
"phone": {
"type": "string",
"maxLength": 40
},
"relationship": {
"type": "string",
"maxLength": 100
}
},
"description": "Emergency contact details to set."
}
}
}