Guides
Signup For Free

Intelli HR API Integration

Suggest Edits

These are the list of integration use cases supported by Knit for Intelli HR API as part of the HRIS category

Delete an Assigned Skill by ID

  • ID: delete_assigned_skill_by_id
  • Operation: write
  • Entities: person, skill
  • Summary: This API deletes an assigned skill from a person using the DELETE method. The endpoint requires two path parameters: 'personId', which is the ID of the relevant person, and 'id', which is the resource identifier of the skill to be deleted. The request must include an 'ApiKey' in the headers for authorization. The API returns a 204 status code on success. In case of errors, it returns a JSON response with details about the error, including a name, message, code, and a list of errors with specific details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Business Entity by ID

  • ID: delete_business_entity_by_id
  • Operation: write
  • Entities: business entity
  • Summary: This API deletes a Business Entity by the given ID. It requires an API key for authorization and the ID of the business entity as a path parameter. The API responds with a 204 status code on success. In case of errors, it returns a JSON object with details about the error, including a name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error, each with specific error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Business Unit by ID

  • ID: delete_business_unit_by_id
  • Operation: write
  • Entities: business unit
  • Summary: This API deletes a business unit identified by the given ID. It requires an API key for authorization. The request method is DELETE and the endpoint is https://api.intellihr.io/v1/business-units/{id}. The path parameter 'id' is required and must be a string representing the resource identifier. The API returns a 204 status code on success. In case of errors, it returns a JSON response with details about the error, including the name, message, code, and a list of errors with specific details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Cancel Job End Date

  • ID: delete_cancel_job_end_date
  • Operation: write
  • Entities: person, job, location
  • Summary: The Cancel Job End Date API allows you to cancel the finalisation of a job end date if it has been previously finalised. This API uses the DELETE method and requires the 'id' path parameter, which is the resource identifier string. Optionally, you can include the 'cancelDisablingUserAccount' query parameter to specify whether to cancel the disabling of the user's account upon the job end date. The response includes detailed information about the job, person, recruitment, extended leave, location, pay grade, business unit, business entity, establishment, and other related data. The API returns a 200 status code with job details on success, and error codes 400, 403, or 500 with corresponding error messages in case of failure.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Custom Field Definition by ID

  • ID: delete_custom_field_definition_by_id
  • Operation: write
  • Entities: custom field definition
  • Summary: This API deletes a Custom Field Definition by the given ID. It requires an API key for authorization and the ID of the custom field definition as a path parameter. The API responds with a 204 status code on success. In case of errors, it returns a JSON object with details about the error, including the name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Job Change Reason by ID

  • ID: delete_job_change_reason_by_id
  • Operation: write
  • Entities: job change reason
  • Summary: This API deletes a Job Change Reason by the given ID. It requires an API key for authorization and the ID of the Job Change Reason as a path parameter. Upon successful deletion, it returns a 204 status code. If there is an error, it returns a JSON response with details about the error, including the name, message, code, and a list of errors if applicable. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Job Requirement by ID

  • ID: delete_job_requirement_by_id
  • Operation: write
  • Entities: job requirement, job
  • Summary: This API deletes a Job Requirement by the given ID. It requires the DELETE method and the endpoint is https://api.intellihr.io/v1/jobs/{jobId}/job-requirements/{id}. The request must include an ApiKey for authorization and path parameters 'jobId' and 'id' which are required. The response can be a success with a 204 status code or an error with details such as name, message, code, and errors array. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Job Requirement Group by ID

  • ID: delete_job_requirement_group_by_id
  • Operation: write
  • Entities: job requirement group
  • Summary: This API deletes a Job Requirement Group by the given ID. It requires an API key for authorization and the ID of the job requirement group as a path parameter. The API responds with a 204 status code on success. In case of errors, it returns a JSON response with details about the error, including the name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Location by ID

  • ID: delete_location_by_id
  • Operation: write
  • Entities: location
  • Summary: This API deletes a location by its ID using the DELETE method. The endpoint requires an API key for authorization and a path parameter 'id' which is the resource identifier string. Upon successful deletion, a 204 status code is returned. If there is an error, the response will include a name, message, code, and a list of errors with details. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Pay Grade by ID

  • ID: delete_pay_grade_by_id
  • Operation: write
  • Entities: pay grade
  • Summary: This API deletes a Pay Grade by the given ID. It requires an API key for authorization and the ID of the Pay Grade as a path parameter. The API responds with a 204 status code on success. In case of errors, it returns a JSON object with details about the error, including the name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Position Title by ID

  • ID: delete_position_title_by_id
  • Operation: write
  • Entities: position title
  • Summary: This API deletes a Position Title by the given ID. It requires an API key for authorization and the ID of the position title as a path parameter. The API responds with a 204 status code on success. If there is an error, it returns a JSON object with details about the error, including the name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Qualification Instance by ID

  • ID: delete_qualification_instance_by_id
  • Operation: write
  • Entities: qualification
  • Summary: This API deletes a Qualification Instance by the given ID. It requires an API key for authorization and the ID of the qualification as a path parameter. The response can be a success with a 204 status code or an error with details in the response body. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error, each providing a name, message, code, and list of errors if applicable.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Qualification Library Item by ID

  • ID: delete_qualification_library_item_by_id
  • Operation: write
  • Entities: qualification library item
  • Summary: This API deletes a Qualification Library Item by the given ID. It requires an API key for authorization and the ID of the qualification library item as a path parameter. The API responds with a 204 status code on success. In case of errors, it returns a JSON response with details about the error, including the name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Delete a Training by ID

  • ID: delete_training_by_id
  • Operation: write
  • Entities: training
  • Summary: This API deletes a training record by its ID. It requires an API key for authorization and the ID of the training record as a path parameter. The API responds with a 204 status code on success. If there is an error, it returns a JSON object with details about the error, including the name, message, code, and a list of errors. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Business Entity by ID

  • ID: get_business_entity_by_id
  • Operation: read
  • Entities: custom field, business entity, response
  • Summary: The 'Find a Business Entity by ID' API allows users to retrieve details of a specific Business Entity using its unique identifier. The API uses a GET request method and requires the 'id' path parameter, which is a string representing the Business Entity's identifier. The response includes detailed information about the Business Entity, such as its name, code, legal name, registration number, and whether it is enabled. Additionally, custom fields associated with the Business Entity are returned, each with its definition ID, name, type, and value. The response also contains meta information, including the timestamp of the response and the request ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Business Unit by ID

  • ID: get_business_unit_by_id
  • Operation: read
  • Entities: custom field, business unit, meta
  • Summary: The 'Find a Business Unit by ID' API allows users to retrieve details of a specific Business Unit by providing its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/business-units/{id}', where '{id}' is the path parameter representing the Business Unit's ID. The API requires an ApiKey for authorization. Upon a successful request, the API returns a JSON object containing details of the Business Unit, including its ID, name, code, notes, parent ID, enabled status, and any custom fields associated with it. The response also includes meta information such as the request ID and the timestamp of the response. In case of an internal server error, the API returns an error message with a status code of 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Custom Field Definition by ID

  • ID: get_custom_field_definition_by_id
  • Operation: read
  • Entities: data type, model type, custom field definition
  • Summary: This API retrieves a single Custom Field Definition by its ID. The request requires an API key for authorization and the ID of the custom field as a path parameter. The response includes details about the custom field such as its name, API name, whether it is enabled or sensitive, its description, model type, data type, and any additional definitions. The response also includes a meta object with a requestId for tracking purposes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Custom Field Definitions

  • ID: get_custom_field_definitions
  • Operation: read
  • Entities: pagination, model, custom field definition
  • Summary: The 'List all Custom Field Definitions' API returns a list of all custom field definitions available in the intelliHR platform. It uses a GET request method and requires an API key for authorization. The endpoint supports query parameters such as 'limit', 'page', and 'filters' to control pagination and filtering of results. Filters can be applied to fields like 'modelType' and 'isEnabled'. The response includes an array of custom field definitions, each with details like 'id', 'name', 'apiName', 'isEnabled', 'isSensitive', 'description', 'modelType', 'type', and 'definitions'. Pagination details and links to related resources are also provided in the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Default Remuneration Component by ID

  • ID: get_default_remuneration_component_by_id
  • Operation: read
  • Entities: remuneration component, job, currency
  • Summary: This API retrieves a single default remuneration component by its ID. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/default-remuneration-components/{id}'. The API requires an API key for authorization and the 'id' path parameter to specify the remuneration component to retrieve. The response includes details such as the component's name, value, usage status, currency, type, and value type, along with a request ID for tracking.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Default Remuneration Components

  • ID: get_default_remuneration_components
  • Operation: read
  • Entities: pagination, default remuneration component, currency
  • Summary: This API endpoint retrieves a list of all Default Remuneration Components recorded in the system. It requires an API key for authorization. The request method is GET, and the endpoint is https://api.intellihr.io/v1/default-remuneration-components. The API accepts optional query parameters 'limit' and 'page' to control pagination. The response includes an array of remuneration components, each with details such as id, name, value, currency, and type. The response also includes pagination metadata and links to navigate through pages. In case of a successful request, a 200 status code is returned with the data, while a 500 status code indicates an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find an Employment Condition by ID

  • ID: get_employment_condition_by_id
  • Operation: read
  • Entities: employment condition, award name, meta information
  • Summary: This API retrieves a single employment condition by its ID. The request method is GET and requires an API key for authorization. The endpoint is 'https://api.intellihr.io/v1/employment-conditions/{id}', where 'id' is a required path parameter representing the resource identifier. The response includes details of the employment condition such as its ID, name, award name, and whether it is enabled. The response also contains meta information including a request ID. In case of a server error, a 500 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find an Extended Leave Type by ID

  • ID: get_extended_leave_type_by_id
  • Operation: read
  • Entities: error, extended leave type, meta
  • Summary: This API retrieves a single Extended Leave Type by its ID. The request method is GET, and the endpoint is https://api.intellihr.io/v1/extended-leave-types/{id}. The API requires an ApiKey for authorization and a path parameter 'id' which is the resource identifier string. On a successful request (HTTP 200), it returns the Extended Leave Type details including 'id' and 'name', along with a 'requestId' in the meta information. In case of an internal server error (HTTP 500), it returns an error object with details such as 'name', 'message', 'code', and 'errors'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Extended Leave Types

  • ID: get_extended_leave_types
  • Operation: read
  • Entities: link, extended leave type, pagination
  • Summary: This API endpoint retrieves a list of all Extended Leave Types available in the system. It requires an API key for authorization. The request can include optional query parameters 'limit' and 'page' to control pagination. The response includes an array of Extended Leave Types, each with an 'id' and 'name', along with pagination metadata and links to navigate through pages. A successful response returns a status code of 200, while a server error returns a 500 status code with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Form by ID

  • ID: get_find_a_form_by_id
  • Operation: read
  • Entities: person, form, job
  • Summary: The 'Find a Form by ID' API allows users to retrieve a single form instance using its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/forms/{id}', where 'id' is a required path parameter representing the form's unique identifier. The response includes detailed information about the form, such as issue date, due date, access code, form design, subject details, submitter details, answers, and document uploads. In case of a successful request, a 200 status code is returned with the form data. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Job by ID

  • ID: get_find_a_job_by_id
  • Operation: read
  • Entities: person, job, location
  • Summary: The 'Find a Job by ID' API allows users to retrieve a single job record using a UUIDv4 identifier. The API requires an API key for authorization and accepts a path parameter 'id' which is mandatory. An optional query parameter 'asAt' can be used to specify the date for which the job data should be returned, formatted as an RFC3339 datetime. The response includes detailed information about the job, such as person details, recruitment information, extended leave, location, pay grade, business unit, business entity, establishment, remuneration schedule, and more. The API returns a 200 status code with the job details on success or a 500 status code with an error message if an internal server error occurs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Person by ID

  • ID: get_find_a_person_by_id
  • Operation: read
  • Entities: person, address, job
  • Summary: The 'Find a Person by ID' API retrieves a single person record using a UUIDv4 identifier. It requires an API key for authorization, which should be sent as 'Authorization: Bearer ', and a path parameter 'id' which is the unique identifier of the person. The 'Content-Type' header must be set to 'application/json'. The API returns detailed information about the person including their name, contact details, employment status, and custom fields. The response includes a comprehensive set of data such as medical conditions, email addresses, emergency contacts, job details, work rights, and more. In case of an internal server error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Skill by ID

  • ID: get_find_a_skill_by_id
  • Operation: read
  • Entities: skill, skill discipline, meta information
  • Summary: The 'Find a Skill by ID' API allows users to retrieve detailed information about a specific skill by providing its unique identifier. The API requires an API key for authorization and the skill ID as a path parameter. Upon a successful request, it returns a JSON object containing the skill's ID, name, description, business criticality status, and associated skill discipline details. The response also includes meta information such as the request timestamp and request ID. In case of an internal server error, an error message with a code is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a User by ID

  • ID: get_find_user_by_id
  • Operation: read
  • Entities: user, permission group, person
  • Summary: The 'Find a User by ID' API allows you to retrieve details of a single user by their unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/users/{id}', where '{id}' is the path parameter representing the user's ID. The request requires an API key for authorization. The response includes detailed information about the user, such as their username, enabled status, creation and update timestamps, permission groups, and associated person details. In case of a successful request, a 200 status code is returned with the user data. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Job Change Reason by ID

  • ID: get_job_change_reason_by_id
  • Operation: read
  • Entities: job change reason, error, response
  • Summary: The 'Find a Job Change Reason by ID' API allows users to retrieve a single Job Change Reason by providing its unique identifier in the path parameters. The request method is GET, and the endpoint is 'https://api.intellihr.io/v1/job-change-reasons/{id}'. An API key is required for authorization. The response includes the Job Change Reason's ID, name, and whether it is enabled, along with meta information such as the request time and request ID. In case of an internal server error, a 500 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Job Requirement Group by ID

  • ID: get_job_requirement_group_by_id
  • Operation: read
  • Entities: qualification library item, job requirement group, meta information
  • Summary: This API retrieves a single Job Requirement Group by its identifier. The request method is GET and requires an API key for authorization. The endpoint is https://api.intellihr.io/v1/job-requirement-groups/{id}, where 'id' is a required path parameter representing the resource identifier. The response includes the Job Requirement Group's ID, name, library items, and usage count, along with meta information such as the request time and request ID. In case of a successful request, a 200 status code is returned with the job requirement group details. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Job Requirement Groups

  • ID: get_job_requirement_groups
  • Operation: read
  • Entities: qualification library item, job requirement group, pagination
  • Summary: This API endpoint retrieves a list of all Job Requirement Groups. It uses a GET request method and requires an API key for authorization. The endpoint supports pagination through query parameters 'limit' and 'page', where 'limit' specifies the number of items per page and 'page' specifies the page number. The response includes a list of job requirement groups, each with an ID, name, associated library items, and a usage count. The response also includes metadata about the request, such as the time the data is accurate as of, pagination details, and a request ID. Additionally, links to navigate through pages are provided. In case of an internal server error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Requirements

  • ID: get_job_requirements
  • Operation: read
  • Entities: qualification, job, requirement
  • Summary: The Get Job Requirements API returns all the requirements for a specified job at a given time. The API requires an API key for authorization and a jobId as a path parameter to identify the relevant job. Optionally, a query parameter 'asAt' can be provided to specify the date for which the job requirements should be returned, using the RFC3339 datetime format. The response includes an array of job requirement objects, each containing details such as the requirement's start and end dates, notification flag, and identifiers. The response also includes meta information about the request. In case of an error, a 500 Internal Server Error response is returned with details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Job Timeline

  • ID: get_job_timeline
  • Operation: read
  • Entities: leave, job, remuneration schedule
  • Summary: The Get Job Timeline API retrieves the upcoming changes and current information about a specific job. It requires a GET request to the endpoint https://api.intellihr.io/v1/jobs/{jobId}/timeline with the path parameter 'jobId' which is the ID of the relevant job. The request must include an 'ApiKey' in the headers for authorization. The response includes detailed information about the job's timeline, such as group time, business units, business entities, FTEs, locations, pay grades, remuneration schedules, supervisors, work classes, work types, direct reports, extended leave, comments, and custom fields. The API returns a 200 status code with the job timeline data or a 500 status code in case of an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Business Entities

  • ID: get_list_all_business_entities
  • Operation: read
  • Entities: custom field, business entity, pagination
  • Summary: The 'List all Business Entities' API returns a list of all business entities available in the system. It uses the GET method and requires an API key for authorization. The endpoint for this API is 'https://api.intellihr.io/v1/business-entities'. The API supports optional query parameters 'limit' and 'page' to control pagination. The response includes an array of business entities, each with details such as 'id', 'name', 'code', 'legalName', 'number', 'isEnabled', and 'customFields'. The 'customFields' object contains additional properties keyed by their API names, with details about each custom field. The response also includes metadata about the request and pagination details, as well as links to navigate through pages. In case of a successful request, a 200 status code is returned with the data, while a 500 status code indicates an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Business Units

  • ID: get_list_all_business_units
  • Operation: read
  • Entities: custom field, filter, business unit
  • Summary: The 'List all Business Units' API endpoint retrieves a list of all Business Units recorded in the system. It requires an API key for authorization. The endpoint supports query parameters such as 'limit' to specify the number of items per page, 'page' to specify the page number, and 'filters' to apply specific conditions to the data returned. The response includes an array of Business Unit objects, each containing details such as 'id', 'name', 'code', 'notes', 'parentId', 'isEnabled', and 'customFields'. The response also includes metadata about the request and pagination details, as well as links to navigate through pages. In case of an error, a 500 Internal Server Error response is returned with details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Documents of a Person

  • ID: get_list_all_documents_of_a_person
  • Operation: read
  • Entities: person, document, pagination
  • Summary: This API endpoint retrieves a list of all documents associated with a specific person identified by the 'personId' path parameter. The request requires an API key for authorization, which should be sent as 'Authorization: Bearer '. The 'Content-Type' header must be set to 'application/json'. Optional query parameters 'limit' and 'page' can be used to control pagination. The response includes a list of document details such as 'id', 'filename', 'downloadUrlAbsolute', 'extension', 'size', 'humanReadableSize', and 'uploadStatus'. Additionally, metadata about the response time and pagination is provided. In case of an error, a 500 status code with error details is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all employment conditions

  • ID: get_list_all_employment_conditions
  • Operation: read
  • Entities: employment condition, link, pagination
  • Summary: This API endpoint retrieves a list of all employment conditions. It requires an API key for authorization. The request method is GET, and the endpoint is https://api.intellihr.io/v1/employment-conditions. The API supports optional query parameters 'limit' and 'page' to control pagination. The response includes an array of employment conditions, each with an ID, name, award name, and a flag indicating if it is enabled. The response also contains pagination metadata and links to navigate through pages. In case of an internal server error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Job Change Reasons

  • ID: get_list_all_job_change_reasons
  • Operation: read
  • Entities: job change reason, link, pagination
  • Summary: The 'List all Job Change Reasons' API returns a list of all job change reasons recorded in the system. It uses the GET method and requires an API key for authorization. The endpoint is 'https://api.intellihr.io/v1/job-change-reasons'. Optional query parameters include 'limit' to specify the number of items per page and 'page' to specify the page number. The response includes an array of job change reasons, each with an 'id', 'name', and 'isEnabled' status. The response also contains meta information such as the 'asAt' timestamp, pagination details, and a 'requestId'. Links to related resources are also provided.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Jobs

  • ID: get_list_all_jobs
  • Operation: read
  • Entities: person, job, location
  • Summary: The 'List all Jobs' API endpoint allows users to retrieve a list of all job entity records as of the current date. The request method is GET, and the endpoint URL is https://api.intellihr.io/v1/jobs. Authorization is required via an API key, which should be sent as Authorization: Bearer . The Content-Type header must be set to application/json. The API supports various query parameters, including 'limit' for the number of items per page, 'page' for the page number, 'filters' for applying specific filters to the data, and 'sort' for sorting the data. Filters can be applied in the query string to limit the data returned from this endpoint. Filters are provided in the format filters[<filter_name>][<operation_type>]=<filter_value>. For example, a filter to get items matching a specific filter value would be filters[personId][eq]=dc996d73-a75e-499c-a96e-bd7d0df45f57,26d0ffc4-60f6-4672-a603-caaa4564af12. The personId is a required filter. The response includes detailed information about each job, including person details, recruitment information, location, pay grade, business unit, business entity, establishment, and more. The response also includes pagination metadata and links for navigating through pages. In case of an error, a 500 Internal Server Error response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All Locations

  • ID: get_list_all_locations
  • Operation: read
  • Entities: custom field, representative, location
  • Summary: The 'List All Locations' API endpoint allows users to retrieve a list of all locations available in the system. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/locations'. The API requires an 'ApiKey' for authorization, which must be included in the request headers. Optional query parameters 'limit' and 'page' can be used to control pagination, specifying the number of items per page and the page number, respectively. The response includes a list of location objects, each containing details such as 'id', 'name', 'code', 'address', and 'representatives'. Additionally, custom fields and pagination metadata are provided. In case of a successful request, a 200 status code is returned with the location data. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Onboarding Templates

  • ID: get_list_all_onboarding_templates
  • Operation: read
  • Entities: onboarding template, link, pagination
  • Summary: This API endpoint retrieves a list of all Onboarding Templates recorded in the system. It requires an API key for authorization. The request method is GET and the endpoint is https://api.intellihr.io/v1/onboarding-templates. The API supports optional query parameters 'limit' and 'page' to control pagination. The response includes an array of onboarding templates, each with an 'id', 'name', and 'isEnabled' status. Additionally, the response contains pagination metadata and links to navigate through pages. In case of a successful request, a 200 status code is returned with the data, while a 500 status code indicates an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all pay grades

  • ID: get_list_all_pay_grades
  • Operation: read
  • Entities: pay grade, pay step, currency
  • Summary: The 'List all pay grades' API endpoint allows users to retrieve a list of all pay grades available in the system. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/pay-grades'. The API requires an 'ApiKey' for authorization. Optional query parameters include 'limit' to specify the number of items per page, 'page' to specify the page number, and 'asAt' to specify the date for which the data should be returned. The response includes a list of pay grades with details such as 'id', 'code', 'name', 'description', 'startDate', 'endDate', 'isEnabled', 'activeJobs', 'isOverridable', 'permanentHourlyRate', 'casualHourlyRate', 'annualSalary', 'payGradeType', 'payGradeValues', 'changeUser', and 'employmentCondition'. The response also includes metadata about the request and pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List All People

  • ID: get_list_all_people
  • Operation: read
  • Entities: person, email address, job
  • Summary: The 'List All People' API endpoint allows users to retrieve a list of all people as of the current date from the IntelliHR system. The request method is GET, and the endpoint URL is https://api.intellihr.io/v1/people. Authorization is required via an API key, which should be sent as 'Authorization: Bearer '. The 'Content-Type' header must be set to 'application/json'. The API supports various query parameters such as 'limit' for the number of items per page, 'page' for the page number, 'filters' to apply specific conditions, and 'sort' to order the data. Filters can be applied to attributes like jobId, primaryEmailAddress, employeeNumber, and more, using equality operations. The response includes detailed information about each person, such as their name, contact details, employment status, and custom fields. The response also includes pagination metadata and links for navigation. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Permission Groups

  • ID: get_list_all_permission_groups
  • Operation: read
  • Entities: permission group
  • Summary: The 'List all Permission Groups' API endpoint allows users to retrieve a list of all permission groups recorded in the system. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/permission-groups'. The API requires an 'ApiKey' for authorization. Users can specify query parameters such as 'limit' to define the number of items per page, 'page' to specify the page number, and 'filters' to apply specific conditions like 'isEnabled'. The response includes a list of permission groups with details such as 'id', 'name', and 'isEnabled' status. Additionally, metadata about the response time, pagination details, and links to related resources are provided. In case of an internal server error, a 500 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all position titles

  • ID: get_list_all_position_titles
  • Operation: read
  • Entities: position title, filter, pagination
  • Summary: The 'List all position titles' API endpoint allows users to retrieve a list of all Position Titles recorded in the system. It uses the GET method and requires an API key for authorization. The endpoint supports query parameters such as 'limit' for the number of items per page, 'page' for the page number, and 'filters' to apply specific conditions on the data returned. The response includes an array of position titles, each with an ID, name, enabled status, and code. Additionally, the response contains pagination details and links to navigate through pages. In case of an error, a 500 Internal Server Error response is returned with details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Qualification Instances

  • ID: get_list_all_qualification_instances
  • Operation: read
  • Entities: qualification, person, qualification library item
  • Summary: The 'List all Qualification Instances' API endpoint allows users to retrieve a paginated list of qualification instances. The request method is GET, and the endpoint URL is 'https://api.intellihr.io/v1/qualifications'. Users must provide an API key for authorization. The API supports query parameters such as 'limit' for the number of items per page, 'page' for the page number, and 'filters' to apply specific conditions on the data returned. Filters can be applied on 'personId', 'employeeNumber', and 'qualificationLibraryItemId' using equality operations. The response includes detailed information about each qualification instance, including its ID, expiry date, issue date, issuing organization, and associated person and library item details. The response also contains metadata about pagination and links to navigate through pages. In case of an error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Qualification Types

  • ID: get_list_all_qualification_types
  • Operation: read
  • Entities: qualification type, error, meta
  • Summary: This API endpoint retrieves a list of all qualification types available in the system. It supports pagination through the 'limit' and 'page' query parameters. The 'limit' parameter specifies the number of items per page, while the 'page' parameter specifies the page number. The API requires an API key for authorization, which should be included in the request headers. On a successful request (HTTP 200), it returns a JSON object containing the qualification type data and meta information such as the request timestamp and request ID. In case of an internal server error (HTTP 500), it returns an error message with details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all recruitment sources

  • ID: get_list_all_recruitment_sources
  • Operation: read
  • Entities: recruitment source, link, pagination
  • Summary: This API endpoint retrieves a list of all recruitment sources available in the system. It uses the GET method and requires an API key for authorization. The endpoint supports pagination through optional query parameters 'limit' and 'page'. The response includes an array of recruitment source objects, each with an ID, name, parent ID, and enabled status. Additionally, the response contains metadata about pagination and links to navigate through pages. In case of a successful request, a 200 status code is returned with the recruitment sources data. If an internal server error occurs, a 500 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Representative Types

  • ID: get_list_all_representative_types
  • Operation: read
  • Entities: representative type, business unit, location
  • Summary: The 'List all Representative Types' API endpoint allows users to retrieve a list of representative types available in the system. The request method is GET, and the endpoint is 'https://api.intellihr.io/v1/representative-types'. The API requires an 'ApiKey' for authorization. Optional query parameters include 'limit' to specify the number of items per page (between 1 and 100) and 'page' to specify the page number (minimum 1). The successful response (HTTP 200) returns a JSON object containing 'data' with details of the representative type, including 'id', 'name', and 'modelType', and 'meta' information with 'asAt' and 'requestId'. In case of an internal server error (HTTP 500), the response includes error details such as 'name', 'message', 'code', and 'errors'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Skills

  • ID: get_list_all_skills
  • Operation: read
  • Entities: skill, skill discipline, pagination
  • Summary: The 'List all Skills' API endpoint allows users to retrieve a list of all skills available in the system. It requires an API key for authorization. Users can specify query parameters such as 'limit' to define the number of items per page, 'page' to specify the page number, and 'filters' to apply specific conditions like 'isBusinessCritical' or 'skillDisciplineId'. The response includes a list of skills with details such as 'id', 'name', 'description', 'isBusinessCritical', and associated 'skillDiscipline'. The response also contains meta information about the request and pagination details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Skills assigned to a Person

  • ID: get_list_all_skills_assigned_to_a_person
  • Operation: read
  • Entities: person, skill, skill discipline
  • Summary: This API endpoint retrieves a list of all skills assigned to a specific person identified by the 'personId' path parameter. The request method is GET and requires an API key for authorization. The response includes an array of skills, each with details such as skill ID, name, skill level, and associated skill discipline. The response also contains meta information including the timestamp of the response and the request ID. The endpoint is not paginated.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Training Providers

  • ID: get_list_all_training_providers
  • Operation: read
  • Entities: training provider, link, pagination
  • Summary: The 'List all Training Providers' API endpoint allows users to retrieve a list of all training providers available in the system. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/training-providers'. The API requires an 'ApiKey' for authorization. Optional query parameters include 'limit' to specify the number of items per page and 'page' to specify the page number. The response includes a list of training providers with details such as 'id', 'name', 'isDefault', and 'isEnabled'. Additionally, the response contains pagination information and links to navigate through pages. In case of a successful request, a 200 status code is returned with the data, while a 500 status code indicates an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Training Statuses

  • ID: get_list_all_training_statuses
  • Operation: read
  • Entities: training status
  • Summary: The 'List all Training Statuses' API returns a list of all training statuses available in the system. It requires an API key for authorization, which should be included in the request headers. The API responds with a 200 status code and a JSON object containing an array of training statuses, each with an 'id' and 'name'. In case of an internal server error, it returns a 500 status code with error details including the error name, message, code, and additional error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Training Types

  • ID: get_list_all_training_types
  • Operation: read
  • Entities: link, training type, pagination
  • Summary: The 'List all Training Types' API returns a list of all available training types. It requires an API key for authorization. The request can include optional query parameters 'limit' and 'page' to control pagination. The response includes an array of training types, each with an ID, name, and flags indicating if it is default or enabled. The response also includes pagination metadata and links to navigate through pages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Trainings

  • ID: get_list_all_trainings
  • Operation: read
  • Entities: training, training provider, training type
  • Summary: The 'List all Trainings' API endpoint allows users to retrieve a list of all training records. The request method is GET, and the endpoint URL is 'https://api.intellihr.io/v1/trainings'. Users must provide an API key for authorization. The API supports various query parameters such as 'limit' for the number of items per page, 'page' for the page number, 'filters' to apply specific conditions, and 'sort' to order the results. The response includes detailed information about each training, such as the training ID, name, status, associated person, job details, coordinator, provider, type, and custom fields. Pagination details and links to navigate through pages are also provided. In case of an error, a 500 status code with an error message is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Users

  • ID: get_list_all_users
  • Operation: read
  • Entities: user, permission group, person
  • Summary: The 'List all Users' API endpoint retrieves a list of all users from the IntelliHR system. It requires an API key for authorization. The request can include optional query parameters 'limit' and 'page' to control pagination. The response includes user details such as 'id', 'username', 'isEnabled', 'createdAt', 'updatedAt', 'userPermissionGroups', 'activeFrom', and 'person' details. The response also contains pagination metadata and links for navigation. In case of an internal server error, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all work classes

  • ID: get_list_all_work_classes
  • Operation: read
  • Entities: work class, work type, pagination
  • Summary: The 'List all work classes' API endpoint retrieves a list of all Work Classes recorded in the system. It uses the GET method and requires an API key for authorization. The endpoint supports query parameters 'limit' and 'page' to control pagination. The response includes a list of work classes, each with an ID, name, work type details, and an 'isEnabled' status. The response also contains pagination metadata and links to navigate through pages. In case of an error, a 500 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Work Rights

  • ID: get_list_all_work_rights
  • Operation: read
  • Entities: pagination, work right, country
  • Summary: The 'List all Work Rights' API returns a list of all Work Rights recorded in the system. It uses the GET method and requires an API key for authorization. The endpoint is 'https://api.intellihr.io/v1/work-rights'. The API accepts optional query parameters 'limit' and 'page' to control pagination. The response includes a list of work rights with details such as 'id', 'name', 'countryId', and 'country'. It also provides pagination metadata and links to navigate through pages. In case of an error, a 500 status code is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Work Types

  • ID: get_list_all_work_types
  • Operation: read
  • Entities: work type, link, pagination
  • Summary: The 'List all Work Types' API endpoint allows users to retrieve a list of all Work Types recorded in the system. The request method is GET and requires an API key for authorization. Users can specify query parameters such as 'limit' to define the number of items per page and 'page' to specify the page number. The response includes a list of Work Types, each with an 'id', 'name', and 'isEnabled' status. The response also contains pagination details and links to navigate through pages. In case of an internal server error, a 500 error response is returned with details about the error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Location by ID

  • ID: get_location_by_id
  • Operation: read
  • Entities: custom field, representative, location
  • Summary: The 'Find a Location by ID' API allows users to retrieve details of a specific location using its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/locations/{id}', where '{id}' is the path parameter representing the location's unique ID. The request requires an API key for authorization. Upon a successful request, the API returns a 200 response with detailed information about the location, including its name, address, representatives, and custom fields. In case of an internal server error, a 500 response is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Pay Grade by ID

  • ID: get_pay_grade_by_id
  • Operation: read
  • Entities: pay grade, pay step, currency
  • Summary: The 'Find a Pay Grade by ID' API allows users to retrieve detailed information about a specific pay grade using its unique identifier. The API requires an API key for authorization and accepts a path parameter 'id' which is mandatory. An optional query parameter 'asAt' can be used to specify the date for which the data should be returned, allowing users to view historical data. The response includes comprehensive details about the pay grade such as its code, name, description, start and end dates, and various financial attributes like hourly rates and annual salary, along with their respective currencies. The response also provides metadata including the request ID and the date for which the data is relevant.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Permission Group by ID

  • ID: get_permission_group_by_id
  • Operation: read
  • Entities: permission group, error, meta information
  • Summary: This API retrieves a single Permission Group by its ID. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/permission-groups/{id}'. The request requires an API key for authorization and a path parameter 'id' which is the identifier of the Permission Group. The response includes the Permission Group's ID, name, and whether it is enabled, along with meta information such as the request time and request ID. In case of a successful request, a 200 status code is returned with the Permission Group details. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Person's Skill by ID

  • ID: get_person_skill_by_id
  • Operation: read
  • Entities: person, skill, skill discipline
  • Summary: This API retrieves a specific skill for a given person by their ID. It requires the 'personId' and 'id' as path parameters, which are both strings. The API key must be provided in the headers for authorization. Upon a successful request (HTTP 200), it returns the skill details including the skill ID, name, skill level, and associated skill discipline. The response also includes meta information such as the request time and request ID. In case of an internal server error (HTTP 500), an error message with details is returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Qualification Instance by ID

  • ID: get_qualification_instance_by_id
  • Operation: read
  • Entities: person, qualification status, qualification instance
  • Summary: This API retrieves a single Qualification Instance by its identifier. The request method is GET and requires an API key for authorization. The endpoint is https://api.intellihr.io/v1/qualifications/{id}, where 'id' is a required path parameter representing the resource identifier. The response includes detailed information about the Qualification Instance, such as its expiry date, issue date, issuing organization, and associated person details. The response is structured in JSON format and includes metadata about the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Qualification Library Item by ID

  • ID: get_qualification_library_item_by_id
  • Operation: read
  • Entities: qualification type, expiry period, qualification library item
  • Summary: This API retrieves a single Qualification Library Item by its identifier. The request method is GET and the endpoint is https://api.intellihr.io/v1/qualification-library-items/{id}. The API requires an 'id' path parameter which is a string representing the resource identifier. The response includes detailed information about the Qualification Library Item, such as its ID, qualification type, and whether expiry warnings are sent. The response also contains meta information like the timestamp of the data and the request ID. In case of a successful request, a 200 status code is returned with the data, while a 500 status code indicates an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Qualification Library Items

  • ID: get_qualification_library_items
  • Operation: read
  • Entities: qualification type, expiry period, qualification library item
  • Summary: This API endpoint retrieves a list of Qualification Library Items from the IntelliHR system. It supports pagination through query parameters 'limit' and 'page'. The response includes detailed information about each qualification library item, such as its ID, name, type, expiry type, and usage counts. The API requires an API key for authorization. The response also includes meta information like the request ID and the timestamp of the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Qualification Status by ID

  • ID: get_qualification_status_by_id
  • Operation: read
  • Entities: qualification status, error, meta information
  • Summary: This API endpoint retrieves a single Qualification Status by its identifier. The request method is GET and the endpoint is https://api.intellihr.io/v1/qualification-statuses/{id}. The path parameter 'id' is required and must be a string representing the resource identifier. On a successful request (HTTP 200), the response includes the Qualification Status data with its 'id' and 'name', along with meta information such as 'asAt' and 'requestId'. In case of an internal server error (HTTP 500), the response includes error details such as 'name', 'message', 'code', and 'errors'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Qualification Type by ID

  • ID: get_qualification_type_by_id
  • Operation: read
  • Entities: qualification type, response schema, pagination
  • Summary: This API endpoint allows users to retrieve a single Qualification Type by its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/qualification-types/{id}', where '{id}' is the path parameter representing the Qualification Type's ID. The request requires an API key for authorization. The response includes the Qualification Type's ID and name, along with metadata such as the request's timestamp and pagination details. In case of a successful request, a 200 status code is returned with the Qualification Type details. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Recruitment Source by ID

  • ID: get_recruitment_source_by_id
  • Operation: read
  • Entities: error, meta, recruitment source
  • Summary: This API endpoint allows you to find a recruitment source by its ID. It requires a GET request to the specified URL with the recruitment source ID as a path parameter. The request must include an API key for authorization. The response will include details of the recruitment source such as its ID, name, parent ID, and whether it is enabled. In case of a successful request, a 200 status code is returned with the recruitment source details. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Representative Type by ID

  • ID: get_representative_type_by_id
  • Operation: read
  • Entities: pagination, representative type, model type
  • Summary: This API retrieves a single Representative Type by its identifier. The request method is GET and requires an API key for authorization. The endpoint is https://api.intellihr.io/v1/representative-types/{id}, where 'id' is a required path parameter representing the resource identifier. The response includes the Representative Type's ID, name, and model type, along with meta information such as the request ID and pagination details. The response is in JSON format and follows the RFC3339 datetime standard for timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Skill Discipline by ID

  • ID: get_skill_discipline_by_id
  • Operation: read
  • Entities: skill, webhook, skill discipline
  • Summary: This API retrieves a Skill Discipline by its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/skill-disciplines/{id}', where 'id' is a required path parameter representing the Skill Discipline's unique identifier. The response includes a JSON object containing the Skill Discipline's ID, name, and an array of associated skills, each with its own ID, name, and link for more information. In case of a successful request, a 200 status code is returned with the Skill Discipline data. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

List all Skill Disciplines

  • ID: get_skill_disciplines
  • Operation: read
  • Entities: skill, skill discipline
  • Summary: The 'List all Skill Disciplines' API returns a list of all Skill Disciplines recorded in the system. It uses the GET method and the endpoint is 'https://api.intellihr.io/v1/skill-disciplines'. The API supports query parameters such as 'limit' for the number of items per page, 'page' for the page number, and 'filters' to apply specific conditions on the data returned. The response includes a list of Skill Disciplines, each with an ID, name, and associated skills. The response also contains pagination information and links to navigate through pages. In case of a successful request, a 200 status code is returned with the data, while a 500 status code indicates an internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Get Temporary Image for Person

  • ID: get_temporary_image_for_person
  • Operation: read
  • Entities: person, image, response
  • Summary: This API retrieves the current temporary image of a specified type for a given person. The request requires an API key for authorization and a path parameter 'personId' to specify the person. An optional query parameter 'imageType' can be used to specify the type of image, such as 'PERSON_PROFILE' or 'PROFILE_COVER'. The response includes the image URL and meta information like the request time and request ID. In case of an internal server error, an error message and code are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Training by ID

  • ID: get_training_by_id
  • Operation: read
  • Entities: provider, person, training
  • Summary: The 'Find a Training by ID' API allows users to retrieve details of a specific training by providing the training ID. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/trainings/{id}'. The API requires an API key for authorization and the 'id' path parameter, which is the unique identifier of the training. The response includes detailed information about the training, such as its name, status, associated person, job details, coordinator, provider, type, and custom fields. In case of a successful request, a 200 status code is returned with the training details. If an internal server error occurs, a 500 status code is returned with an error message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Training Provider by ID

  • ID: get_training_provider_by_id
  • Operation: read
  • Entities: training record, training provider, response
  • Summary: This API endpoint allows you to find a Training Provider by its ID. It requires a GET request to the specified URL with the path parameter 'id' which is the unique identifier of the Training Provider. The request must include an 'ApiKey' in the headers for authorization. On success, it returns a 200 response with details of the Training Provider including its ID, name, default status, and enabled status. In case of an internal server error, a 500 response is returned with error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Training Type by ID

  • ID: get_training_type_by_id
  • Operation: read
  • Entities: error, response, training type
  • Summary: This API endpoint allows users to find a specific Training Type by its ID. The request method is GET, and it requires an API key for authorization. The path parameter 'id' is required and should be a string representing the resource identifier. On a successful request (HTTP 200), the response includes the Training Type's details such as 'id', 'name', 'isDefault', and 'isEnabled', along with a 'requestId' in the meta object. In case of an internal server error (HTTP 500), the response contains error details including 'name', 'message', 'code', and 'errors'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Work Class by ID

  • ID: get_work_class_by_id
  • Operation: read
  • Entities: work class, meta information, work type
  • Summary: This API retrieves a single work class by its ID. The request requires an API key for authorization and a path parameter 'id' which is the resource identifier string for the work class. The response includes details of the work class such as its ID, name, associated work type, and whether it is enabled. The work type includes its own ID, name, and a link for more information. The response also contains meta information including a request ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Work Right by ID

  • ID: get_work_right_by_id
  • Operation: read
  • Entities: work right, meta, country
  • Summary: The 'Find a Work Right by ID' API allows users to retrieve details of a specific work right using its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/work-rights/{id}', where '{id}' is the path parameter representing the work right's ID. The request requires an API key for authorization. Upon a successful request (HTTP 200), the response includes the work right's ID, name, country ID, and country name, along with a meta object containing the request ID. In case of an internal server error (HTTP 500), the response includes error details such as the error name, message, code, and any additional error information.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Work Type by ID

  • ID: get_work_type_by_id
  • Operation: read
  • Entities: error, meta information, work type
  • Summary: The 'Find a Work Type by ID' API allows users to retrieve details of a specific work type by providing its unique identifier. The request is made using the GET method to the endpoint 'https://api.intellihr.io/v1/work-types/{id}', where '{id}' is the path parameter representing the work type's ID. The API requires an API key for authorization. Upon a successful request (HTTP 200), the response includes the work type's ID, name, and whether it is enabled. In case of an internal server error (HTTP 500), an error message and code are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Find a Workflow Event by ID

  • ID: get_workflow_event_by_id
  • Operation: read
  • Entities: workflow, workflow event, form design
  • Summary: This API retrieves a single Workflow Event by its identifier. It requires an API key for authorization and the 'id' path parameter to specify the Workflow Event to retrieve. The response includes detailed information about the Workflow Event, including its name, action name, description, and associated workflows. Each workflow contains details such as its name, description, and associated workflow form designs, which include form design details and timing information relative to the event.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

End a Job

  • ID: patch_end_a_job
  • Operation: write
  • Entities: person, job, location
  • Summary: The 'End a Job' API allows you to set an end date and finalize a job within the organization. It uses the PATCH method and requires the job ID as a path parameter. Optional query parameters include 'shouldNotFinaliseEndDate', 'shouldRetainUserAccount', and 'suppressEvents'. The request body must include 'endDate' and 'turnoverType', with optional fields 'reassignDirectReportsTo' and 'turnoverReason'. The response provides detailed job information, including person details, recruitment, extended leave, location, pay grade, business unit, and more. Error responses include 400 for bad requests, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch an existing Job

  • ID: patch_existing_job
  • Operation: write
  • Entities: business entity, job, supervisor person
  • Summary:
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch an Existing Job Requirement Group

  • ID: patch_existing_job_requirement_group
  • Operation: write
  • Entities: qualification library item, job requirement group, meta information
  • Summary: This API allows you to patch attributes of an existing Job Requirement Group record with the provided data. The PATCH method is used at the endpoint https://api.intellihr.io/v1/job-requirement-groups/{id}. The request requires an API key for authorization and the 'id' path parameter to specify the Job Requirement Group to be updated. The request body must include the 'name' and 'libraryItemIds' fields. On success, it returns the updated Job Requirement Group details, including its ID, name, library items, and usage count. The response also includes meta information such as the request ID and timestamp. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch an existing Pay Grade

  • ID: patch_existing_pay_grade
  • Operation: write
  • Entities: pay grade step, pay grade, employment condition
  • Summary: This API allows you to patch attributes of an existing Pay Grade record with the provided data. The PATCH method is used at the endpoint https://api.intellihr.io/v1/pay-grades/{id}. The request requires an API key for authorization and the 'id' path parameter to identify the Pay Grade. The request body must include 'effectiveFrom' as a required field, while other fields such as 'effectiveTo', 'isEnabled', 'name', 'code', 'description', 'employmentCondition', 'payGradeType', 'isOverridable', 'permanentHourlyRate', 'permanentHourlyRateCurrency', 'casualHourlyRate', 'casualHourlyRateCurrency', 'annualSalary', 'annualSalaryCurrency', and 'paySteps' are optional. The response includes details of the updated Pay Grade, including its 'id', 'code', 'name', 'description', 'startDate', 'endDate', 'isEnabled', 'activeJobs', 'isOverridable', 'permanentHourlyRate', 'permanentHourlyRateCurrency', 'casualHourlyRate', 'casualHourlyRateCurrency', 'annualSalary', 'annualSalaryCurrency', 'payGradeType', 'payGradeValues', 'changeUser', and 'employmentCondition'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch an existing Position Title

  • ID: patch_existing_position_title
  • Operation: write
  • Entities: position title, response schema, request body
  • Summary: This API allows you to patch attributes of an existing Position Title record with the provided data. The request method is PATCH and the endpoint is https://api.intellihr.io/v1/position-titles/{id}. It requires an API key for authorization. The path parameter 'id' is required to identify the resource. The request body must include 'name' and 'isEnabled', while 'code' is optional. The response can be a success (200) with the updated Position Title details, or it can return errors such as Bad Request (400), Forbidden (403), or Internal Server Error (500) with appropriate error messages and codes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch an existing Qualification Library Item

  • ID: patch_existing_qualification_library_item
  • Operation: write
  • Entities: qualification type, expiry period, qualification library item
  • Summary: This API allows you to patch attributes of an existing Qualification Library Item record with the provided data. The PATCH method is used at the endpoint https://api.intellihr.io/v1/qualification-library-items/{id}. The request requires an API key for authorization and the 'id' path parameter to identify the resource. The request body must include the name, qualificationTypeId, qualificationExpiryType, qualificationRegistrationNumberVisibilityType, and qualificationAttachmentRequirementType. Optional fields include expiryWarningPeriod and sendExpiryWarning. The response returns the updated Qualification Library Item details, including its id, name, qualification type, expiry settings, and usage counts. The response also includes meta information such as the request timestamp and request ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Promote Temporary Image

  • ID: patch_promote_temporary_image
  • Operation: write
  • Entities: person, error, image
  • Summary: The 'Promote Temporary Image' API activates a temporary image as the active image on a Person with minor editing options. It uses the PATCH method at the endpoint 'https://api.intellihr.io/v1/people/{personId}/images'. The API requires an ApiKey for authorization and a 'personId' as a path parameter. The request body must include 'imageType', 'rotation', and 'coordinates' for cropping the image. The response can return various HTTP status codes, including 204 for success, 400 for bad requests, 403 for forbidden access, and 500 for internal server errors. The response body provides details about any errors encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch a Skill Discipline

  • ID: patch_skill_discipline
  • Operation: write
  • Entities: skill, skill discipline
  • Summary: The 'Patch a Skill Discipline' API allows users to update the name of an existing Skill Discipline identified by its unique ID. The request requires an API key for authorization and the ID of the Skill Discipline as a path parameter. The request body must include the new name for the Skill Discipline. Upon a successful request, the API returns the updated Skill Discipline details, including its ID, name, and associated skills. The response also includes a meta object containing the request ID. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error, each providing details about the error encountered.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Trigger a Workflow by ID

  • ID: patch_trigger_workflow_by_id
  • Operation: write
  • Entities: workflow, workflow form design, job
  • Summary: This API triggers a workflow by its ID and related Workflow Form Designs using a PATCH request. The endpoint requires a path parameter 'id' which is the UUID of the workflow to be triggered. The request body must include 'jobId' and 'workflowFormDesigns', where 'jobId' is the UUID of the job for which the workflow is triggered, and 'workflowFormDesigns' is an array of objects containing 'id' and optional 'sendDate' for each form design. The response includes details of the triggered workflow, scheduled forms, and a meta object with a requestId. Possible responses include success (200), bad request (400), forbidden (403), and internal server error (500).
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Person

  • ID: patch_update_a_person
  • Operation: write
  • Entities: person, contact, job
  • Summary: The 'Update a Person' API allows you to update the details of a person in the IntelliHR system. The API uses the PATCH method and requires an API key for authorization. The endpoint is 'https://api.intellihr.io/v1/people/{id}', where 'id' is the required path parameter representing the person's unique identifier. The request body can include various optional fields such as 'firstName', 'lastName', 'emailAddresses', 'phoneNumbers', and more, allowing for comprehensive updates to a person's profile. The response includes detailed information about the updated person, including their name, contact details, employment status, and custom fields. The API
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Skill

  • ID: patch_update_a_skill
  • Operation: write
  • Entities: skill, error, skill discipline
  • Summary: The 'Update a Skill' API allows users to update the details of a specific skill in the system. The API requires a PATCH request to the endpoint 'https://api.intellihr.io/v1/skills/{id}', where '{id}' is the unique identifier of the skill to be updated. The request must include an API key for authorization. The path parameter 'id' is required to specify which skill is being updated. The request body must include the 'name', 'description', 'isBusinessCritical', and 'skillDisciplineId' fields, all of which are required. The response will include the updated skill details, including its ID, name, description, business critical status, and associated skill discipline information. The response also contains meta information such as the request ID and the timestamp of the response. In case of errors, the API can return status codes 400 (Bad Request), 403 (Forbidden), or 500 (Internal Server Error) with appropriate error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Training

  • ID: patch_update_a_training
  • Operation: write
  • Entities: person, training, job
  • Summary: The 'Update a Training' API allows users to update details of a specific training session in the intelliHR system. The API uses the PATCH method and requires an API key for authorization. The endpoint requires a path parameter 'id' which is the unique identifier of the training to be updated. The request body must be in JSON format and can include details such as the coordinator of the training, completion date, cost, currency, hours spent, job details, training name, person who did the training, provider, type, custom fields, and status. The response includes the updated training details, including the training ID, name, status, person, job, coordinator, hours, currency, cost, provider, type, completion date, creation and update timestamps, and custom fields. The API returns various HTTP status codes, including 200 for success, 400 for bad requests, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update an Assigned Skill

  • ID: patch_update_assigned_skill
  • Operation: write
  • Entities: person, skill, skill discipline
  • Summary: The 'Update an Assigned Skill' API allows you to update the skill level of a specific skill assigned to a person. The API requires a PATCH request to the endpoint 'https://api.intellihr.io/v1/people/{personId}/skills/{id}', where 'personId' and 'id' are path parameters representing the person and the skill respectively. The request body must include the 'skillLevel' field, which can be one of the following: Expert, Proficient, Interested, or Basic. The API uses an ApiKey for authorization. On success, it returns a 200 response with details of the updated skill, including its ID, name, skill level, and associated skill discipline. In case of errors, it returns appropriate error messages with status codes 400, 403, or 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Business Entity by ID

  • ID: patch_update_business_entity_by_id
  • Operation: write
  • Entities: custom field, business entity, legal name
  • Summary: This API allows updating a Business Entity by its ID. The request method is PATCH and the endpoint is https://api.intellihr.io/v1/business-entities/{id}. It requires an API key for authorization. The path parameter 'id' is required to specify the Business Entity to update. The request body must include the 'name', 'code', 'legalName', 'number', and 'isEnabled' fields. Custom fields can also be updated by providing their values. The response returns the updated Business Entity details, including its ID, name, code, legal name, number, isEnabled status, and custom fields. The response also includes meta information such as the request ID and the timestamp of the response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Business Unit by ID

  • ID: patch_update_business_unit_by_id
  • Operation: write
  • Entities: custom field, response, business unit
  • Summary: This API allows you to update a Business Unit by its ID. The request method is PATCH and the endpoint is https://api.intellihr.io/v1/business-units/{id}. You must provide an API key for authorization. The path parameter 'id' is required to specify the Business Unit to update. The request body must include the 'name' of the Business Unit, and can optionally include 'identifier', 'code', 'notes', 'parentId', 'isEnabled', and 'customFields'. The response will return the updated Business Unit details, including its 'id', 'name', 'code', 'notes', 'parentId', 'isEnabled', and 'customFields'. The response also includes meta information such as 'asAt' and 'requestId'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Custom Field Definition

  • ID: patch_update_custom_field_definition
  • Operation: write
  • Entities: people dropdown definition, option, custom field definition
  • Summary: This API updates a Custom Field Definition in the IntelliHR system. It requires a PATCH request to the endpoint with the resource identifier in the path. The request must include an ApiKey for authorization. The body of the request should contain the name, description, isEnabled, isSensitive, selectDefinition, and peopleDropdownDefinition of the custom field. The response returns the updated Custom Field Definition, including its id, name, apiName, isEnabled status, sensitivity, description, modelType, type, and any additional definitions. The response also includes a meta object with the requestId.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Document

  • ID: patch_update_document
  • Operation: write
  • Entities: person, person document, request
  • Summary: The 'Update a Document' API allows users to update details of a document associated with a person in the IntelliHR system. The API requires a PATCH request to the endpoint 'https://api.intellihr.io/v1/person-documents/{id}', where 'id' is the resource identifier for the document. The request must include an API key for authorization. The request body must contain the 'personId' (UUIDv4) of the person to whom the document belongs, and optionally the 'filename' and 'uploadStatus'. The response will return a 200 status code with the updated document details if successful. In case of errors, it may return 400 (Bad Request), 403 (Forbidden), or 500 (Internal Server Error) with appropriate error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Job Change Reason by ID

  • ID: patch_update_job_change_reason_by_id
  • Operation: write
  • Entities: job change reason, response, request
  • Summary: This API allows you to update a Job Change Reason by its ID. The request method is PATCH and the endpoint is https://api.intellihr.io/v1/job-change-reasons/{id}. You must provide an API key for authorization. The path parameter 'id' is required to specify the Job Change Reason to update. The request body must include 'name' (a string representing the name of the Job Change Reason) and 'isEnabled' (a boolean indicating if the Job Change Reason can be selected in dropdowns). On success, the API returns the updated Job Change Reason details including 'id', 'name', and 'isEnabled', along with meta information such as 'asAt' (the response time) and 'requestId' (the request identifier). Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error, each with specific error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Job Requirement

  • ID: patch_update_job_requirement
  • Operation: write
  • Entities: job requirement, qualification, job
  • Summary: The 'Update a Job Requirement' API allows users to update a job requirement for a specific job by providing the job ID and requirement ID. The API uses the PATCH method and requires an API key for authorization. The path parameters include 'jobId' and 'id', both of which are required. The request body must include 'startDate', 'endDate', and 'notifyEmployee', all of which are required fields. The response can be a success (200) with details of the updated job requirement, or it can return error codes 400 (Bad Request), 403 (Forbidden), or 500 (Internal Server Error) with appropriate error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Location by ID

  • ID: patch_update_location_by_id
  • Operation: write
  • Entities: custom field, representative, location
  • Summary: This API allows you to update a location by its ID. The request method is PATCH and the endpoint is https://api.intellihr.io/v1/locations/{id}. You must provide an API key for authorization. The path parameter 'id' is required to specify the location to be updated. The request body must include 'parentId', 'name', 'code', 'address', and 'isEnabled'. Custom fields can also be updated if provided. The response will return the updated location details, including representatives and custom fields. Possible response codes include 200 for success, 400 for bad request, 403 for forbidden, and 500 for internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update or Finalise Extended Leave

  • ID: patch_update_or_finalise_extended_leave
  • Operation: write
  • Entities: person, extended leave, job
  • Summary: The 'Update or Finalise Extended Leave' API allows users to update or finalise an existing extended leave record. The PATCH request requires an API key for authorization and the extended leave ID as a path parameter. The request body must include the job ID and end date, with optional fields for start date, leave type, and full-time equivalent (FTE) depending on whether the end date is being finalised. The response includes metadata about the request and detailed information about the extended leave, job, and person associated with the leave. The API returns a 200 status code on success, with potential error responses for bad requests, forbidden access, or internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Qualification Instance by ID

  • ID: patch_update_qualification_instance_by_id
  • Operation: write
  • Entities: person, qualification library item, qualification instance
  • Summary: This API allows you to update a Qualification Instance by its ID. The request method is PATCH and the endpoint is https://api.intellihr.io/v1/qualifications/{id}. You must provide an API key for authorization. The path parameter 'id' is required to specify the Qualification Instance to update. The request body must include the status, issuing organisation, registration number, issue date, expiry date, expiry notification queued date, and notes for the Qualification Instance. The response returns the updated Qualification Instance details, including the ID, expiry date, issue date, issuing organisation, notes, person details, qualification status, status, library item, and registration number. The response also includes meta information such as the request ID and the point in time for which the response is valid.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Patch a User by ID

  • ID: patch_user_by_id
  • Operation: write
  • Entities: user, permission group, onboarding form
  • Summary: This API allows you to update a user by their ID. The PATCH request requires an API key for authorization and the user's ID as a path parameter. The request body must include 'isEnabled' and 'username' fields, and optionally 'activeFrom' and 'onboardingTemplateId'. The response returns the updated user details, including their ID, username, status, creation and update timestamps, permission groups, and associated person details. Error responses include 400 for bad requests, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Assign a Skill to a Person

  • ID: post_assign_skill_to_person
  • Operation: write
  • Entities: person, skill, skill discipline
  • Summary: This API assigns a skill to an existing person in the system. It requires a POST request to the endpoint with the person's ID in the path parameters. The request body must include the skill ID and the skill level, which can be one of the following: Expert, Proficient, Interested, or Basic. The API requires an API key for authorization. Upon successful creation, it returns a 201 status code with details of the assigned skill, including its ID, name, skill level, and associated skill discipline. In case of errors, it returns appropriate error messages with status codes such as 400 for bad requests, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a person

  • ID: post_create_a_person
  • Operation: write
  • Entities: user account, person, job
  • Summary: The 'Create a person' API allows you to create a new person record in the IntelliHR system. This API requires a POST request to the endpoint 'https://api.intellihr.io/v1/people'. The request must include an Authorization header with a Bearer token for authorization and a Content-Type header set to 'application/json'. The request body should contain details about the person, such as their first name, last name, date of birth, gender, employee number, and other optional fields like middle name, preferred name, title, emergency contact, email addresses, phone numbers, addresses, custom fields, medical conditions, work rights, and user account details. The response will include the created person's details, including their ID, display name, employment status, jobs, work rights, primary email and phone number, addresses, and user account information. The API also handles errors, returning appropriate error messages for bad requests, forbidden access, and internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Custom Field Definition

  • ID: post_create_custom_field_definition
  • Operation: write
  • Entities: model type, api request, custom field definition
  • Summary: This API endpoint allows the creation of a Custom Field Definition in the IntelliHR system. The request method is POST, and the endpoint is 'https://api.intellihr.io/v1/custom-field-definitions'. The request requires an API key for authorization. The request body must include the 'name', 'apiName', 'modelType', and 'type' fields, with optional fields such as 'description', 'isSensitive', 'selectDefinition', 'textDefinition', and 'peopleDropdownDefinition'. The response returns the created Custom Field Definition with details such as 'id', 'name', 'apiName', 'isEnabled', 'isSensitive', 'description', 'modelType', 'type', and 'definitions'. The response also includes a 'meta' object containing the 'requestId'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Extended Leave

  • ID: post_create_extended_leave
  • Operation: write
  • Entities: person, extended leave, job
  • Summary: The 'Create Extended Leave' API allows users to create a new extended leave for an existing job in the intelliHR system. The API requires a POST request to the endpoint 'https://api.intellihr.io/v1/extended-leave' with an Authorization header containing a Bearer token for authorization. The request body must include the job ID, start date, end date, and leave type, with an optional full-time equivalent (FTE) value. The response returns a 201 status code upon successful creation, providing details about the extended leave, including meta information, leave type, job, and person details. Error responses include 400 for bad requests, 403 for forbidden access, and 500 for internal server errors.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Job Change Reason

  • ID: post_create_job_change_reason
  • Operation: write
  • Entities: job change reason
  • Summary: This API endpoint allows the creation of a new Job Change Reason in the system. It requires an API key for authorization. The request body must include the 'name' of the Job Change Reason, which is required, and an optional 'isEnabled' boolean to specify if the reason can be selected by users. Upon successful creation, it returns a 201 status code with the details of the created Job Change Reason, including its 'id', 'name', and 'isEnabled' status, along with meta information such as 'asAt' and 'requestId'. In case of errors, it returns appropriate error messages with status codes 400, 403, or 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Job Requirement Group

  • ID: post_create_job_requirement_group
  • Operation: write
  • Entities: qualification library item, job requirement group
  • Summary: This API endpoint allows the creation of a new Job Requirement Group record with the provided data. The request method is POST and the endpoint is https://api.intellihr.io/v1/job-requirement-groups. The request requires an API key for authorization. The request body must include the 'name' of the Job Requirement Group and an array of 'libraryItemIds' which are UUIDs representing the Qualification Library Items assigned to this group. Upon successful creation, the API returns a 201 status code with a response body containing the details of the created Job Requirement Group, including its ID, name, library items, and usage count. The response also includes meta information such as the request ID and the timestamp of the response. In case of errors, the API may return status codes 400 (Bad Request), 403 (Forbidden), or 500 (Internal Server Error) with corresponding error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create Job Requirements

  • ID: post_create_job_requirements
  • Operation: write
  • Entities: job requirement, qualification, job
  • Summary: The 'Create Job Requirements' API allows users to create a new job requirement for a specific job by sending a POST request to the specified endpoint. The request requires an API key for authorization and a jobId as a path parameter. The request body must include the startDate and endDate in RFC3339 format, a boolean notifyEmployee flag, and identifiers for the job requirementableId and jobRequirementableType. The API responds with a 201 status code and the created job requirement details upon success. In case of errors, it returns appropriate error messages with status codes 400, 403, or 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Business Entity

  • ID: post_create_new_business_entity
  • Operation: write
  • Entities: custom field, business entity
  • Summary: This API endpoint allows the creation of a new Business Entity in the IntelliHR system. The request method is POST, and the endpoint URL is https://api.intellihr.io/v1/business-entities. The request requires an API key for authorization. The request body must include the 'name' of the Business Entity, while other fields such as 'code', 'legalName', 'number', 'isEnabled', and 'customFields' are optional. The 'customFields' object can contain various custom fields keyed by their API names. The response returns the created Business Entity with details such as 'id', 'name', 'code', 'legalName', 'number', 'isEnabled', and 'customFields'. The response also includes meta information like 'asAt' and 'requestId'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Business Unit

  • ID: post_create_new_business_unit
  • Operation: write
  • Entities: field, person, business unit
  • Summary: This API endpoint allows the creation of a new Business Unit within the IntelliHR system. The request method is POST, and the endpoint is https://api.intellihr.io/v1/business-units. The request requires an API key for authorization. The request body must include the 'name' of the Business Unit, while other fields such as 'identifier', 'code', 'notes', 'parentId', 'isEnabled', and 'customFields' are optional. The 'customFields' object can contain various custom field values keyed by their API names. Upon successful creation, the API returns a 201 status code with the details of the created Business Unit, including its 'id', 'name', 'code', 'parentId', 'isEnabled', and 'customFields'. The response also includes meta information such as 'asAt' and 'requestId'. In case of errors, the API may return 400, 403, or 500 status codes with appropriate error messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Job

  • ID: post_create_new_job
  • Operation: write
  • Entities: job, company, person
  • Summary:
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Job Record

  • ID: post_create_new_job_record
  • Operation: write
  • Entities: job, company, person
  • Summary:
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Location

  • ID: post_create_new_location
  • Operation: write
  • Entities: custom field, person, location
  • Summary: This API endpoint allows the creation of a new location within the IntelliHR system. The request method is POST, and the endpoint is https://api.intellihr.io/v1/locations. The request requires an API key for authorization. The request body must include the 'parentId' and 'name' fields, while 'code', 'address', 'isEnabled', and 'customFields' are optional. The 'customFields' object can contain various custom field values keyed by their API names. The response returns the created location's details, including its ID, name, code, address, and custom fields. The response also includes metadata such as the request timestamp and request ID. Possible error responses include 400 Bad Request, 403 Forbidden, and 500 Internal Server Error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Pay Grade

  • ID: post_create_new_pay_grade
  • Operation: write
  • Entities: pay grade step, pay grade, employment condition
  • Summary: This API endpoint allows the creation of a new Pay Grade record with the provided data. The request method is POST and the endpoint is https://api.intellihr.io/v1/pay-grades. The request requires an API key for authorization. The request body must be in JSON format and include details such as the name, code, description, employment condition, pay grade type, and various rates and currencies. The response includes the created Pay Grade details, including its ID, name, description, rates, and associated employment condition. The API also handles errors with appropriate status codes and messages.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Position Title

  • ID: post_create_new_position_title
  • Operation: write
  • Entities: position title
  • Summary: This API endpoint allows the creation of a new Position Title record in the system. The request method is POST, and the endpoint is https://api.intellihr.io/v1/position-titles. The request requires an API key for authorization. The request body must include the 'name' of the Position Title, which is required, and optionally a 'code'. The response for a successful creation (HTTP 201) includes the Position Title's ID, name, enabled status, and code, along with a request ID. Error responses include HTTP 400 for bad requests, HTTP 403 for forbidden access, and HTTP 500 for internal server errors, each providing relevant error details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Skill

  • ID: post_create_new_skill
  • Operation: write
  • Entities: skill, error, skill discipline
  • Summary: This API endpoint allows the creation of a new Skill in the system. It requires a POST request to the URL https://api.intellihr.io/v1/skills with an API key for authorization. The request body must include the name, description, isBusinessCritical status, and skillDisciplineId of the Skill. Upon successful creation, it returns a 201 status code with the details of the created Skill, including its ID, name, description, business critical status, and associated Skill Discipline. In case of errors, it returns appropriate error messages with status codes 400, 403, or 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a New Training

  • ID: post_create_new_training
  • Operation: write
  • Entities: provider, person, training
  • Summary: This API endpoint allows the creation of a new training record in the intelliHR system. The request method is POST, and the endpoint is https://api.intellihr.io/v1/trainings. The request requires an API key for authorization. The request body must include details about the training, such as the coordinator person, completion date, cost, currency, hours, job, name, person, provider, type, custom fields, and status. The response will include the created training details, including the training ID, name, status, person, job, coordinator, hours, currency, cost, provider, type, completion date, creation date, update date, and custom fields. The response also includes a meta object with a request ID for tracking purposes. Possible response codes include 201 for success, 400 for bad request, 403 for forbidden, and 500 for internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Presigned Upload URL for Person Documents

  • ID: post_create_presigned_upload_url
  • Operation: write
  • Entities: url, person, document
  • Summary: This API endpoint is used to create a presigned upload URL for uploading person documents to S3. The request method is POST, and it requires an API key for authorization, which should be sent as 'Authorization: Bearer '. The 'Content-Type' header must be set to 'application/json'. The URL includes a path parameter 'personId' which is required to identify the person to whom the document belongs. The request body must include the document's filename, MIME type, size, and extension. Upon successful creation, the API returns a presigned upload URL, which expires 20 minutes after creation, along with the document's ID. The response also includes a request ID for tracking purposes. In case of errors, appropriate HTTP status codes and error messages are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Qualification Instance

  • ID: post_create_qualification_instance
  • Operation: write
  • Entities: qualification, person, qualification library item
  • Summary: This API creates a new Qualification Instance in the IntelliHR system. It requires a POST request to the endpoint https://api.intellihr.io/v1/qualifications with an API key for authorization. The request body must include the personId, qualificationLibraryItemId, and status as required fields. Optional fields include issuingOrganisation, registrationNumber, issueDate, expiryDate, expiryNotificationQueuedAt, and notes. The response returns the created Qualification Instance with details such as id, expiryDate, issueDate, issuingOrganisation, and associated person and library item information. Possible response codes include 201 for success, 400 for bad request, 403 for forbidden, and 500 for internal server error.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a new Qualification Library Item

  • ID: post_create_qualification_library_item
  • Operation: write
  • Entities: qualification type, expiry period, qualification library item
  • Summary: This API endpoint allows the creation of a new Qualification Library Item record. It requires a POST request to the specified URL with a JSON body containing details such as the name, qualification type ID, expiry type, registration number visibility type, and attachment requirement type. Optional fields include expiry warning period and whether to send expiry warnings. The response includes the created item's details, including its ID, name, and usage counts, along with metadata about the request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a Skill Discipline

  • ID: post_create_skill_discipline
  • Operation: write
  • Entities: skill, skill discipline
  • Summary: This API endpoint allows the creation of a new Skill Discipline in the system. The request method is POST and the endpoint URL is https://api.intellihr.io/v1/skill-disciplines. The request requires an API key for authorization and a JSON body containing the 'name' of the Skill Discipline. Upon successful creation, it returns a 201 status code with the Skill Discipline details including its ID, name, and associated skills. In case of errors, it returns appropriate error messages with status codes 400, 403, or 500.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Create a User

  • ID: post_create_user
  • Operation: write
  • Entities: user, permission group, person
  • Summary: The 'Create a User' API allows you to create a new user for a person who does not already have a user account in the intelliHR system. The API requires a POST request to the endpoint 'https://api.intellihr.io/v1/users' with an API key for authorization. The request body must include the 'username' and 'person' object, which identifies the person to whom the user belongs. Optional fields include 'isEnabled', 'permissionGroups', 'activeFrom', and 'onboardingTemplateId'. The response includes the created user's details, such as 'id', 'username', 'isEnabled', 'createdAt', 'updatedAt', and associated 'userPermissionGroups'. In case of errors, appropriate error messages and codes are returned.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Generate Temporary Image Upload URL for Person

  • ID: post_generate_temporary_image_upload_url_for_person
  • Operation: write
  • Entities: url, person, image
  • Summary: This API generates a temporary image upload URL for a specified person. It requires the personId as a path parameter and an API key for authorization. The request body must include the imageType and extension. The response includes a presigned S3 URL and fields necessary for uploading the image, along with meta information such as the requestId and timestamp.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 7 days ago