{"info":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","description":"

The TalentHR provides many API products, tools, and resources that enable you to integrate TalentHR with your internal software.

\n

🚀 Getting started guide

\n

To start using the TalentHR API, you need to:

\n\n

🔒Authentication

\n

The TalentHR API uses \"basic authentication\" for authentication.

\n

TalentHR uses API keys for authentication. You can generate a TalentHR API key in the API section of your TalentHR domain settings.

\n

When using Basic Auth within the TalentHR API, the username must be set as the API Key obtained from the system. However, the password field can be left blank or set to a random string, as it has no impact on the authentication process at this time. You can fill these fields in the global variables of TalentHR API.

\n

You can construct and send basic auth headers following these steps:

\n
    \n
  1. Generate an API key for TalentHR (How to generate an API key).
    2. \n
  2. Build a string of the form api_key:123. The username part is set to “api_key” and the password part is set to a random string “123”, in this case.
    3. \n
  3. BASE64 encode the string.
    4. \n
\n\n
echo -n api_key:random_string | base64\n\n
\n\n
$Text = ‘api_key:random_string’$Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)$EncodedText = [Convert]::ToBase64String($Bytes)$EncodedText\n\n
\n

Supply an Authorization header with content Basic followed by the encoded string. For example, the string samplekey:123 encodes to c2FtcGxla2V5OjEyMw== in base64, so you would make the request as follows:

\n
curl -D- \\   -X GET \\   -H \"Authorization: Basic c2FtcGxla2V5OjEyMw==\" \\   -H \"Content-Type: application/json\" \\\"https://pubapi.talenthr.io/v1/directory\"\n\n
\n

Authentication error response

\n

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

\n

Rate and usage limits

\n

API access rate limits apply at a per-API key basis in unit time. The limit is 2000 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

\n

ℹ️ Need some help?

\n

In case you have questions, please go through our Knowledge Base or you can contact our support at support@talenthr.io

\n
\n

Additional Information

\n
1. 📖 Pagination mechanism :
\n\n

Some endpoints in the talentHR API implement a paging mechanism to efficiently break large datasets into smaller, more manageable chunks. The pagination mechanism is consisted of two essential attributes: offset & limit. The pagination can be disabled by setting the offset parameter to -1. The limit parameter determines the maximum number of records returned per call, while the offset parameter indicates the current page. In case the limit parameter is not specified in a request, the system defaults to a limit of 10.

\n

Pagination starts from an offset of 0, with subsequent pages based on the defined limit. For instance, if the limit is set to 10 records, the offset for the next page would be calculated as previous_offset + limit. For example, if the previous offset is 0 and the limit is 10, the offset for the next page would be 0 + 10 = 10, and so forth.

\n
2. 🛠️ Custom Fields :
\n\n

The system offers three distinct categories of custom fields for managing information: pre-existing , employees and assets custom fields.

\n

Pre-existing custom fields are fields that already exist in the system and have an essential part to employee's information. They include a variety of types, such as text, single and multiple choice, links, and blended options. Among these, the blended option is a complex field that comprises additional attributes. (e.g. driver's license blended option consists of 4 fields; Number, Issued date, Expiry date, Issuing country).

\n

Some pre-existing custom fields are enabled by default from the system's initiation, allowing immediate use without requiring a subscription. These readily accessible custom fields include:

\n\n

To access additional pre-existing custom fields, a subscription is necessary. These fields encompass a wider range of attributes and they are the following:

\n\n

Note: The type or visibility of these pre-existing custom fields cannot be modified, as they are predefined.

\n

Employee custom fields can be used to capture information for employees. The type of them can vary from text to long text, from single to multiple-choice, links, references to employees, or dates. In addition, these custom fields have adjustable visibility settings, allowing access exclusively to the employee, to the manager, both to the employee and his/her manager, or universally to all. You have the ability to create an employee custom field even without a subscription; this means the field exists in an idle state until the necessary subscription is acquired, enabling its use.

\n

Asset custom fields can be used to capture information for assets. The type of them can vary from text to long text, from single to multiple-choice, links, references to employees, or dates. In addition, these custom fields have adjustable visibility settings, allowing access exclusively to the employee, to the manager, both to the employee and his/her manager, or universally to all. Also, an additional option is available that allows these fields to be specifically applied to inventory, memberships, or universally across all asset types. You have the ability to create an asset custom field even without a subscription; this means the field exists in an idle state until the necessary subscription is acquired, enabling its use.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"32971767","collectionId":"39f4121a-d6e2-48c3-a941-0c031292b69c","publishedId":"2sA35HX1mC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-04-01T12:38:43.000Z"},"item":[{"name":"Domain Settings","item":[{"name":"Get all system's timezones","id":"877ac170-e5c4-4aeb-b789-6eaa79eb1bb2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/timezones","description":"

API endpoint to get the available timezones.

\n\n

This API endpoint retrieves a list of available timezones supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["timezones"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"4a23eeaf-0be6-4b08-bf41-e6de1d0b4366","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/timezones"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n \"Africa/Cairo\",\n \"America/Los_Angeles\",\n \"America/New_York\",\n \"Asia/Hong_Kong\",\n \"Asia/Qatar\",\n \"Australia/Perth\",\n \"Australia/Melbourne\",\n \"Europe/Athens\"\n ]\n}"}],"_postman_id":"877ac170-e5c4-4aeb-b789-6eaa79eb1bb2"},{"name":"Get all languages","id":"a7048895-91f1-459a-9bd3-45aa19463241","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/languages","description":"

API endpoint to get the available languages.

\n\n

This API endpoint retrieves a list of available languages supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["languages"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"05cad63a-d654-41d0-a313-e0358c98c2f6","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/languages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"English\",\n \"code\": \"en\",\n \"is_disabled\": 0\n },\n {\n \"id\": 3,\n \"name\": \"Spanish\",\n \"code\": \"es\",\n \"is_disabled\": 0\n }\n ]\n}"}],"_postman_id":"a7048895-91f1-459a-9bd3-45aa19463241"},{"name":"Get all countries","id":"4d331fe9-9e9f-4c1e-b848-7e2076ac0189","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/countries","description":"

API endpoint to get the available countries.

\n\n

This API endpoint retrieves a list of available countries supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["countries"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"47acfce7-5aab-41c8-a425-4fddb35c00d8","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/countries"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n \"Afghanistan\",\n \"Argentina\",\n \"Bosnia and Herzegowina\",\n \"Botswana\",\n \"China\",\n \"Finland\",\n \"France\",\n \"Greece\",\n \"India\",\n \"Spain\"\n ]\n}"}],"_postman_id":"4d331fe9-9e9f-4c1e-b848-7e2076ac0189"},{"name":"Get all nationalities","id":"e3f3f91b-e2ff-43cc-a9ff-987951f1f92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/nationalities","description":"

API endpoint to get the available nationalities.

\n\n

This API endpoint retrieves a list of available nationalities supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["nationalities"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"4b455453-9a0c-4fcb-b192-fa57d14f9b57","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/nationalities"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n \"Afghan\",\n \"Albanian\",\n \"Algerian\",\n \"American\",\n \"Andorran\",\n \"Angolan\",\n \"Antiguans\",\n \"Argentinean\",\n \"Armenian\",\n \"Australian\"\n ]\n}"}],"_postman_id":"e3f3f91b-e2ff-43cc-a9ff-987951f1f92e"},{"name":"Get the education Levels","id":"2cdcb373-f69a-41a5-81f2-c2d66426f3ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/education-levels","description":"

API endpoint to get all available education levels.

\n\n

This API endpoint retrieves a list of available education levels supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["education-levels"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"166ad69c-a779-414b-8b13-dfaab95c58e5","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/education-levels"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"High School\"\n },\n {\n \"id\": 2,\n \"name\": \"Other\"\n },\n {\n \"id\": 3,\n \"name\": \"MSc\"\n },\n {\n \"id\": 4,\n \"name\": \"BSc\"\n },\n {\n \"id\": 5,\n \"name\": \"PhD\"\n }\n ]\n}"}],"_postman_id":"2cdcb373-f69a-41a5-81f2-c2d66426f3ed"},{"name":"Get the employment statuses","id":"58f66d30-ca8d-48b2-8962-1ad848de4537","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employment-statuses","description":"

API endpoint to get all available employment statuses.

\n\n

This API endpoint retrieves a list of available employment statuses supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employment-statuses"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"860b36bc-62d9-4243-8be5-c2bc621dc125","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employment-statuses"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Full-Time\"\n },\n {\n \"id\": 2,\n \"name\": \"Part-Time\"\n },\n {\n \"id\": 3,\n \"name\": \"Contractor\"\n },\n {\n \"id\": 4,\n \"name\": \"Terminated\"\n },\n {\n \"id\": 5,\n \"name\": \"Furloughed\"\n }\n ]\n}"}],"_postman_id":"58f66d30-ca8d-48b2-8962-1ad848de4537"},{"name":"Get the relationship types","id":"536c78cc-71b3-42ca-8828-30c969f73898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/relationship-types","description":"

API endpoint to get all available relationship types.

\n\n

This API endpoint retrieves a list of available relationship types supported by the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["relationship-types"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"accc31da-7ba4-4874-bcfc-bc9af5140a0e","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/relationship-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Wife/Husband\"\n },\n {\n \"id\": 2,\n \"name\": \"Mother\"\n },\n {\n \"id\": 3,\n \"name\": \"Father\"\n },\n {\n \"id\": 4,\n \"name\": \"Daughter\"\n },\n {\n \"id\": 5,\n \"name\": \"Son\"\n }\n ]\n}"}],"_postman_id":"536c78cc-71b3-42ca-8828-30c969f73898"}],"id":"4a4fb4b0-dcbf-4597-8bd4-61a681aa2b9d","_postman_id":"4a4fb4b0-dcbf-4597-8bd4-61a681aa2b9d","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Employee","item":[{"name":"Create an employee (Hire)","id":"2950f0ba-b27b-4d4b-855f-4b79b667767c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\", // (Required) Maximum character limit: 191 characters.\n \"last_name\": \"\", // (Required) Maximum character limit: 191 characters.\n \"email\": \"\", // (Required) It has to be valid email format and structure. Maximum character limit: 191 characters. The email has to be unique.\n \"hire_date\": \"\", // (Required) The hire date must be formatted as 'YYYY-MM-DD'.\n \"employment_status\": { // (Required) Object with properties: employment_status_id (integer).\n \"employment_status_id\": \"\" // The employment status Id\n },\n \"reports_to_employee_id\": \"\", // (Required) If the reports_to_employee_id is 'null' then the current employee will be the head of the company.\n \"job_record\": { // Object with properties: job_title_id (integer,nullable), location_id (integer,nullable), division_id (integer,nullable), department_id (integer,nullable).\n \"job_title_id\": \"\", // Job Title Id\n \"location_id\": \"\", // Location Id\n \"division_id\": \"\", // Division Id\n \"department_id\": \"\" // Department Id\n },\n \"compensation_record\": { // Object with properties: pay_rate (integer), pay_rate_period (enum,nullable) , pay_schedule (enum,nullable), overtime_status (enum,nullable)\n \"pay_rate\": \"\", // Employee's wage and must have 2 decimals. E.g 1255.38\n \"pay_rate_period\": \"\", // Enum value [hour, day, week, month, quarter, year]. The period over which money is earned.\n \"pay_rate_schedule\": \"\", // Enum value [once-per-month, twice-per-month, every-other-week]. Frequency of the wage.\n \"overtime_status\": \"\" // Enum value [exempt, non-exempt]. Determining whether an employee is exempt or non-exempt from overtime regulations.\n },\n \"prevent_email\": \"\", // Opt for 'true', if you don't want to send an invitation email to the hiring employee, else 'false'..\n \"is_existing\": \"\", // Opt for 'false' if the employee is a new hire and you want to run the Automatic Onboarding process, else 'true'.\n \"hire_packet\": { // Info for the new hire. Object with properties: who_id (integer), address (string), when_time (date-time), instructions (string)\n \"who_id\": \"\", // The employee who will meet the newly hired employee. Required if when_time and address is present.\n \"address\": \"\", // The address where the meeting will take place. Required if who_id and _when_time is present. Maximum character limit: 20000 characters.\n \"when_time\": \"\", // The date time that the meeting will take place. Required if who_id and address is present. The hire date must be formatted as 'YYYY-MM-DD HH:II'.\n \"instructions\": \"\" // Important Instructions for the newly hired employee. Maximum character limit: 250 characters.\n }\n\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/hire","description":"

API Endpoint to create an employee.

\n\n

This API endpoint facilitates the creation of an employee within the system. When creating an employee, it's necessary to provide essential personal information such as first name, last name, and email address. Additionally, the endpoint requires details regarding the employee's hire date, employment status, and manager.

\n

When we are adding a new employee, we should avoid creating loops or circles in the organization hierarchy.

\n

If the is_existing parameter is set to true the onboarding process is bypassed. Otherwise, if it's set to false, the employee is considered a new hire, and the system initiates the onboarding process for the newly hired employee.

\n

In cases where no manager is specified, the employee becomes the head of the company hierarchy.

\n

You can choose to disable the initial system invite.

\n

In case you want to provide some additional information on onboarding new hires at the organization, you should fill in the hire packet object with the necessary information. This allow you to send an a email to the hiring employee containing detailed instructions for their first day of work.

\n
\n

After the successful creation of a newly hired employee's profile, an email is dispatched to the new hire containing essential information required for registering with the domain. This includes details such as login credentials, and any other relevant information to facilitate their smooth integration into the company's systems. Additionally, emails are sent to existing employees who are assigned the responsibility of conducting the onboarding tasks for the new employee.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
first_namestringtrueMaximum character limit: 191 characters.e.g. John
last_namestringtrueMaximum character limit: 191 characters.e.g. Doe
emailstringtrueIt has to be valid email format and structure. Maximum character limit: 191 characters. The email has to be unique.e.g. john.doe@example.com
hire_datedatetrueThe hire date must be formatted as 'YYYY-MM-DD'.e.g. 2024-01-10
reports_to_employee_idintegertrueThe employee Id that will be the manager of the current employee. If the reports_to_employee_id is 'null' then the current employee will be the head of the company.-
employment_statusobjecttrueObject with properties: employment_status_id (integer).e.g. {\"employment_status_id\": 1}
job_recordobjectfalseObject with properties: job_title_id (integer,nullable), location_id (integer,nullable), division_id (integer,nullable), department_id (integer,nullable). All the variables must be present.e.g. {\"job_title_id\": 1, \"location_id\": 12,
\"division_id\":null,
\"department_id\":20}
compensation_recordobjectfalseObject with properties: pay_rate (integer), pay_rate_period (enum,nullable) [hour, day, week, month, quarter, year], pay_schedule (enum,nullable) [once-per-month, twice-per-month, every-other-week], overtime_status (enum,nullable) [exempt, non-exempt]e.g. {\"pay_rate\": 1000, \"pay_rate_period\": \"day\", \"pay_schedule\":\"once-per-month\", \"overtime_status\":null}
prevent_emailbooleanfalseOpt for 'true', if you don't want to send an invitation email to the hiring employee, else 'false'.-
is_existingbooleanfalseOpt for 'false' if the employee is a new hire and you want to run the Automatic Onboarding process, else 'true'.-
hire_packetobjectfalseInfo for the new hire.Object with properties: who_id (integer, id of employees), address (string), when_time (date-time), instructions (string)e.g. {\"who-id\":1, \"address\": \"Random Str 123A\", \"when_time\":\"2024-03-10 17:00\", \"instructions\": \"These are some instructions...\"}
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees","hire"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"fe02995d-c722-4f1d-a660-d7581aa5c2ca","name":"OK (200)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"hire_date\": \"\",\n \"employment_status\": {\n \"employment_status_id\": \"\"\n },\n \"reports_to_employee_id\": \"\",\n \"job_record\": {\n \"job_title_id\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\"\n },\n \"compensation_record\": {\n \"pay_rate\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate_schedule\": \"\",\n \"overtime_status\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/hire"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"hire_date_utc\": \"2024-02-28 22:00:00\",\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/public-assets/people/default-avatar.png...\",\n \"hire_date\": \"2024-02-29\",\n \"id\": 41,\n \"user_role\": {\n \"id\": 3,\n \"name\": \"Employee\",\n \"slug\": \"employee\"\n },\n \"seniority\": {\n \"years\": 0,\n \"months\": 0,\n \"days\": 0\n },\n \"termination_reason\": \"\",\n \"custom_fields\": [],\n \"default_avatar\": true,\n \"location_name\": null,\n \"division_name\": null,\n \"department_name\": null,\n \"job_title_name\": null,\n \"short_manager\": {\n \"manager_id\": 15,\n \"manager_name\": \"Black Mia\",\n \"manager_employee_number\": null,\n \"location_name\": \"Athens\",\n \"department_name\": \"Administration & Operations\",\n \"division_name\": \"Europe\",\n \"job_title_name\": \"Administrative Assistant\",\n \"linked_in_url\": null,\n \"work_phone\": \"work-phone\",\n \"email\": \"mblack@example.com\",\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/15_1700059591.jpg...\",\n \"is_me\": false\n },\n \"is_terminated\": false,\n \"visa_status\": null,\n \"user\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": null,\n \"email\": \"john.doe@example.com\",\n \"last_login_at\": null\n },\n \"hire_packet\": {\n \"id\": 5,\n \"employee_id\": 41,\n \"who_id\": 15,\n \"instructions\": \"these are instructions...\",\n \"address\": \"address-name\",\n \"when_time\": \"2024-03-01 00:00:00\",\n \"timezone\": \"Europe/Athens\",\n \"created_at\": \"2024-02-29T10:37:33.000000Z\",\n \"updated_at\": \"2024-02-29T10:37:33.000000Z\",\n \"deleted_at\": null,\n \"who\": {\n \"id\": 15,\n \"user_id\": 15,\n \"user\": {\n \"id\": 15,\n \"first_name\": \"Mia\",\n \"last_name\": \"Black\"\n }\n }\n },\n \"emergency_contact\": null\n }\n}"},{"id":"0fe01a74-ecc1-438b-aea9-49d0cec36111","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"hire_date\": \"\",\n \"employment_status\": {\n \"employment_status_id\": \"\"\n },\n \"reports_to_employee_id\": \"\",\n \"job_record\": {\n \"job_title_id\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\"\n },\n \"compensation_record\": {\n \"pay_rate\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate_schedule\": \"\",\n \"overtime_status\": \"\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/hire"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"2950f0ba-b27b-4d4b-855f-4b79b667767c"},{"name":"Get an employee","id":"43259b6a-44be-49ee-bd12-340bccd764a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee","description":"

API Endpoint to get the information of an employee.

\n\n

This API endpoint retrieves the basic information of a specific employee from the system based on the provided employee ID.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"dc83c9b5-86bd-42ef-b7c8-fcc2c1ec87ae","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"613dd3ef-28b8-404e-9747-659cc8adb1d0","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 15,\n \"ssn\": null,\n \"birth_date\": \"1997-05-30\",\n \"hire_date\": \"2012-01-02\",\n \"hire_date_utc\": \"2012-01-02 14:45:25\",\n \"personal_email\": \"johndoe@example.com\",\n \"marital_status\": null,\n \"nationality\": null,\n \"work_phone\": \"phone-number\",\n \"country\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"linked_in_url\": null,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/15_1700059591.jpg...\",\n \"citizenship\": null,\n \"termination_date\": null,\n \"gender\": \"Male\",\n \"job_title_id\": 25,\n \"division_id\": 13,\n \"department_id\": 6,\n \"location_id\": 36,\n \"employee_number\": null,\n \"user_role\": {\n \"id\": 3,\n \"name\": \"Employee\",\n \"slug\": \"employee\"\n },\n \"seniority\": {\n \"years\": 12,\n \"months\": 1,\n \"days\": 27\n },\n \"termination_reason\": \"\",\n \"custom_fields\": [\n {\n \"custom_field_id\": 47,\n \"custom_field_slug\": \"custom-field-001\",\n \"custom_field_name\": \"Custom Field 001\",\n \"values\": [\n {\n \"value\": \"https://www.mydomain.com/custom-fields\"\n }\n ]\n }\n ],\n \"default_avatar\": false,\n \"location_name\": \"Athens\",\n \"division_name\": \"Europe\",\n \"department_name\": \"Administration & Operations\",\n \"job_title_name\": \"Administrative Assistant\",\n \"short_manager\": {\n \"manager_id\": 1,\n \"manager_name\": \"Mia Black\",\n \"manager_employee_number\": null,\n \"location_name\": \"Athens\",\n \"department_name\": \"Administration & Operations\",\n \"division_name\": \"Europe\",\n \"job_title_name\": \"Chief Executive Officer\",\n \"linked_in_url\": null,\n \"work_phone\": \"work-phone\",\n \"email\": \"mblack@example.com\",\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1700059519_NNcbnWBX.jpg...\",\n \"is_me\": true\n },\n \"is_terminated\": false,\n \"user\": {\n \"first_name\": \"Doe\",\n \"last_name\": \"John\",\n \"middle_name\": null,\n \"email\": \"johndoe@example.com\",\n \"last_login_at\": \"2023-11-15 16:47:50\"\n },\n \"hire_packet\": null,\n \"emergency_contact\": {\n \"id\": 13,\n \"employee_id\": 15,\n \"relationship_type_id\": 2,\n \"full_name\": \"Susan Doe\",\n \"phone\": \"phone-number\",\n \"address\": \"address-name\",\n \"created_at\": \"2024-02-29T11:58:38.000000Z\",\n \"updated_at\": \"2024-02-29T11:58:38.000000Z\",\n \"deleted_at\": null\n }\n}"},{"id":"3bc9911c-a22e-4f96-a2ab-f94e8e1f5ed2","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"43259b6a-44be-49ee-bd12-340bccd764a9"},{"name":"Update an employee","id":"87427fa6-389b-4472-a186-bd6231c4cae6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\", // (Required) Maximum character limit: 191 characters.\n \"last_name\": \"\", // (Required) Maximum character limit: 191 characters.\n \"email\": \"\", // (Required) It has to be valid email format and structure. Maximum character limit: 191 characters. The email has to be unique.\n \"ssn\": \"\", // Maximum character limit: 191 characters.\n \"birth_date\": \"\", // The birth date must be formatted as 'YYYY-MM-DD' and must be between now and 1930-01-01.\n \"personal_email\": \"\", // It has to be valid email format and structure. Maximum character limit: 191 characters. The email has to be unique (among personal emails).\n \"marital_status\": \"\", // Enum value [Single, Separated, Married, Widowed]\n \"gender\": \"\", // Enum value [Male, Female, Non-binary]\n \"nationality\": \"\", // This must be a valid nationality from the provided 'nationalities' of the system.\n \"citizenship\": \"\", // This must be a valid citizenship from the provided 'citizenships' of the system.\n \"work_phone\": \"\", // Maximum character limit: 191 characters.\n \"mobile_phone\": \"\", // Maximum character limit: 191 characters.\n \"phone\": \"\", // Maximum character limit: 191 characters.\n \"address\": \"\", // Maximum character limit: 191 characters.\n \"country\": \"\", // This must be a valid country from the provided 'countries' of the system.\n \"postal_code\": \"\", // Maximum character limit: 191 characters.\n \"city\": \"\", // Maximum character limit: 191 characters.\n \"reports_to_employee_id\": \"\", // The Id of the employee that is the manager of the current employee. In case of null the employee is the head of the company.\n \"emergency_contact\": {\n \"full_name\": \"\",\n \"relationship_type_id\": \"\", // This must be a valid relationship type from the provided 'relationship-types' of the system.\n \"phone\": \"\",\n \"address\": \"\"\n },\n \"linked_in_url\": \"\", // This has to be a valid URL.\n \"employee_number\": \"\", // Maximum character limit: 191 characters.\n \"passport_number\": \"\", // Pre-existing field. Maximum character limit: 64 characters.\n \"passport_issued_date\": \"\", // Pre-existing field. The passport's issued date must be formatted as 'YYYY-MM-DD' and must be before or equal today's date.\n \"passport_expiry_date\": \"\", // Pre-existing field. The passport's expiry date must be formatted as 'YYYY-MM-DD'.\n \"passport_issuing_country\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value must be a valid country from the provided 'countries' of the system.\n \"visa_type\": \"\", // Pre-existing field. Maximum character limit: 191 characters.\n \"visa_number\": \"\", // Pre-existing field. Maximum character limit: 64 characters.\n \"visa_expiry_date\": \"\", // Pre-existing field. The visa's expiry date must be formatted as 'YYYY-MM-DD'.\n \"driver_license_number\": \"\", // Pre-existing field. Maximum character limit: 64 characters.\n \"driver_license_issued_date\": \"\", // Pre-existing field. The license's issued date must be formatted as 'YYYY-MM-DD'.\n \"driver_license_expiry_date\": \"\", // Pre-existing field. The license's expiry date must be formatted as 'YYYY-MM-DD'.\n \"driver_license_issuing_country\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value must be a valid country from the provided 'countries' of the system.\n \"sec_address\": \"\", // Pre-existing field. Maximum character limit: 191 characters.\n \"sec_city\": \"\", // Pre-existing field. Maximum character limit: 191 characters.\n \"sec_postal_code\": \"\", // Pre-existing field. Maximum character limit: 191 characters.\n \"sec_country\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value must be a valid country from the provided 'countries' of the system.\n \"twitter_url\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.\n \"facebook_url\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.\n \"instagram_url\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.\n \"pinterest_url\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.\n \"github_url\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.\n \"behance_url\": \"\", // Pre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.\n \"skype_name\": \"\", // Pre-existing field. Maximum character limit: 191 characters.\n \"shirt_size\": \"\", // Pre-existing field. The Id of shirt sizes.\n \"t_shirt_size\": \"\", // Pre-existing field. The Id of t-shirt sizes.\n \"hr_languages\": [ // Pre-existing field. Array of integers with the hr-languages' Ids.\n \"\",\n \"\"\n ],\n \"hr_family\": [ // Pre-existing field. Array of objects with the family members of the current employee.\n {\n \"name\": \"\", // Maximum character limit: 191 characters.\n \"gender\": \"\", // Enum value [Male, Female, Non-binary]\n \"birth_date\": \"date\", // The birth date must be formatted as 'YYYY-MM-DD'.\n \"family_member_relationship_id\": \"\" // This value must be a valid relationship from the provided 'relationship_types' of the system.\n }\n ],\n \"allergies\": \"\", // Pre-existing field. Maximum character limit: 4000 characters.\n \"prevent_email\": \"\",\n \"custom_field_01\": \"\", // Custom Field (Type: Text). Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_02\": \"\", // Custom Field (Type: Long Text). Maximum character limit: 5000 characters. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_03\": \"\", // Custom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_04\": [ // Custom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n \"\",\n \"\"\n ],\n \"custom_field_05\": \"\", // Custom Field (Type: Date). The custom-field's date must be formatted as 'YYYY-MM-DD'. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_06\": \"\", // Custom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_07\": \"\" // Custom Field (Type: Employee). This custom field must contain the Id of the Employee. The custom field's name (key) corresponds to the slug of the custom field.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee","description":"

API Endpoint to update the information of an employee.

\n\n

This API endpoint enables the updating of an employee's information within the system based on the provided employee ID. You can modify various aspects of an employee's record, including personal details, contact information, designation, and any other relevant data stored within the system.

\n
\n

When updating an employee's profile, you can modify the custom fields associated with that employee. However, it is important to note that the availability of this feature is dependent on your TalentHR subscription (Refer to the Introductory chapter for further details). The custom fields associated with an employee can be retrieved using the 'Get employee's custom fields' endpoint.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
first_namestringtrueMaximum character limit: 191 characters.e.g. John
last_namestringtrueMaximum character limit: 191 characters.e.g. Doe
emailstringtrueIt has to be a valid email format and structure. Maximum character limit: 191 characters. The email has to be unique.e.g. john.doe@example.com
ssnstringfalseMaximum character limit: 191 characters.e.g. 123-45-6789
birth_datedatefalseThe birth date must be formatted as 'YYYY-MM-DD' and must be between now and 1930-01-01.e.g. 1997-11-05
personal_emailstringfalseIt has to be a valid email format and structure. Maximum character limit: 191 characters. The email has to be unique (among personal emails).-
marital_statusenumfalse-Single, Separated, Married, Widowed
genderenumfalse-Male, Female, Non-binary
nationalitystringfalseThis must be a valid nationality from the provided 'nationalities' of the system.-
citizenshipstringfalseThis must be a valid citizenship from the provided 'citizenships' of the system.-
work_phonestringfalseMaximum character limit: 191 characters.-
mobile_phonestringfalseMaximum character limit: 191 characters.-
phonestringfalseMaximum character limit: 191 characters.-
addressstringfalseMaximum character limit: 191 characters.-
countrystringfalseThis must be a valid country from the provided 'countries' of the system.-
postal_codestringfalseMaximum character limit: 191 characters.-
citystringfalseMaximum character limit: 191 characters.-
reports_to_employee_idintegerfalseThe Id of the employee that is the manager of the current employee. In case of null the employee is the head of the company.-
emergency_contactobjectfalseObject with properties: full_name (string), relationship_type_id (integer, This must be a valid relationship type from the provided 'relationship-types' of the system.), address (string), phone (string)e.g. {\"full_name\": \"John Doe\", \"relationship_type_id\": 1, \"address\": \"Random Str 123A\", \"phone\" : \"00302101234567\"}
linked_in_urlstringfalseThis has to be a valid URL.-
employee_numberstringfalseMaximum character limit: 191 characters.-
passport_numberstringfalsePre-existing field. Maximum character limit: 64 characters.-
passport_issued_datedatefalsePre-existing field. The passport's issued date must be formatted as 'YYYY-MM-DD' and must be before or equal to today's date.-
passport_expiry_datedatefalsePre-existing field. The passport's expiry date must be formatted as 'YYYY-MM-DD'.-
passport_issuing_countrystringfalsePre-existing field. Maximum character limit: 191 characters. This value must be a valid country from the provided 'countries' of the system.-
visa_typestringfalsePre-existing field. Maximum character limit: 191 characters.-
visa_numberstringfalsePre-existing field. Maximum character limit: 64 characters.-
visa_expiry_datedatefalsePre-existing field. The visa's expiry date must be formatted as 'YYYY-MM-DD'.-
driver_license_numberstringfalsePre-existing field. Maximum character limit: 64 characters.-
driver_license_issued_datedatefalsePre-existing field. The license's issued date must be formatted as 'YYYY-MM-DD'.-
driver_license_expiry_datedatefalsePre-existing field. The license's issued date must be formatted as 'YYYY-MM-DD'.-
driver_license_issuing_countrystringfalsePre-existing field. Maximum character limit: 191 characters. This value must be a valid country from the provided 'countries' of the system.-
sec_addressstringfalsePre-existing field. Maximum character limit: 191 characters.-
sec_citystringfalsePre-existing field. Maximum character limit: 191 characters.-
sec_postal_codestringfalsePre-existing field. Maximum character limit: 191 characters.-
sec_countrystringfalsePre-existing field. Maximum character limit: 191 characters. This value must be a valid country from the provided 'countries' of the system.-
twitter_urlstringfalsePre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.-
facebook_urlstringfalsePre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.-
instagram_urlstringfalsePre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.-
pinterest_urlstringfalsePre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.-
github_urlstringfalsePre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.-
behance_urlstringfalsePre-existing field. Maximum character limit: 191 characters. This value has to be a valid URL.-
skype_namestringfalsePre-existing field. Maximum character limit: 191 characters.-
shirt_sizeintegerfalsePre-existing field. The ID of shirt sizes.-
t_shirt_sizeintegerfalsePre-existing field. The ID of t-shirt sizes.-
hr_languagesarrayfalsePre-existing field. Array of integers with the hr-languages' Ids.-
hr_familyarrayfalseArray of objects with the family members. Object properties: name (string), gender (enum) [Male, Female, Non-binary], birth_date (date), family_member_relationship_id (integer)e.g. [{\"name\":\"John Doe\", \"gender\": \"Male\", \"birth_date\": \"1986-10-20\", \"family_member_relationship_id\":1}]
allergiesstringfalsePre-existing field. Maximum character limit: 4000 characters.-
custom_field_01stringfalseCustom Field (Type: Text). Maximum character limit: 255 characters.e.g. \"This is a text...\"
custom_field_02stringfalseCustom Field (Type: Long Text). Maximum character limit: 5000 characters.e.g. \"This is a long text...\"
custom_field_03integerfalseCustom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options.e.g. 3
custom_field_04arrayfalseCustom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options.e.g. [3,4]
custom_field_05datefalseCustom Field (Type: Date). The custom field's date must be formatted as 'YYYY-MM-DD'.e.g. 2024-03-10
custom_field_06stringfalseCustom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters.e.g. \"https://www.domainexample.com/\"
custom_field_07integerfalseCustom Field (Type: Employee). This custom field must contain the Id of the Employee.e.g. 1
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"4445f7c7-5495-4fff-9f20-466fecd8e578","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"4844ee2e-9b54-4992-94ba-155a5aa2720a","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"ssn\": \"\",\n \"birth_date\": \"\",\n \"hire_date\": \"\",\n \"personal_email\": \"\",\n \"marital_status\": \"\",\n \"gender\": \"\",\n \"nationality\": \"\",\n \"citizenship\": \"\",\n \"ethnicity\": \"\",\n \"work_phone\": \"\",\n \"mobile_phone\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"country\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"reports_to_employee_id\": \"\",\n \"emergency_contact\": {\n \"full_name\": \"\",\n \"relationship_type_id\": \"\",\n \"phone\": \"\",\n \"address\": \"\"\n },\n \"linked_in_url\": \"\",\n \"is_existing\": \"\",\n \"employee_number\": \"\",\n \"passport_number\": \"\",\n \"passport_issued_date\": \"\",\n \"passport_expiry_date\": \"\",\n \"passport_issuing_country\": \"\",\n \"visa_type\": \"\",\n \"visa_number\": \"\",\n \"visa_expiry_date\": \"\",\n \"driver_license_number\": \"\",\n \"driver_license_issued_date\": \"\",\n \"driver_license_expiry_date\": \"\",\n \"driver_license_issuing_country\": \"\",\n \"sec_address\": \"\",\n \"sec_city\": \"\",\n \"sec_postal_code\": \"\",\n \"sec_country\": \"\",\n \"twitter_url\": \"\",\n \"facebook_url\": \"\",\n \"instagram_url\": \"\",\n \"pinterest_url\": \"\",\n \"github_url\": \"\",\n \"behance_url\": \"\",\n \"skype_name\": \"\",\n \"shirt_size\": \"\",\n \"t_shirt_size\": \"\",\n \"hr_languages\": [\n \"\",\n \"\"\n ],\n \"allergies\": \"\",\n \"prevent_email\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"ssn\": null,\n \"birth_date\": \"1997-05-30\",\n \"hire_date\": \"2012-01-02\",\n \"hire_date_utc\": \"2012-01-02 14:45:25\",\n \"personal_email\": \"johndoe@example.com\",\n \"marital_status\": null,\n \"nationality\": null,\n \"work_phone\": \"phone-number\",\n \"country\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"linked_in_url\": null,\n \"citizenship\": null,\n \"termination_date\": null,\n \"gender\": \"Male\",\n \"job_title_id\": 25,\n \"division_id\": 13,\n \"department_id\": 6,\n \"location_id\": 36,\n \"employee_number\": null,\n \"user_role\": {\n \"id\": 3,\n \"name\": \"Employee\",\n \"slug\": \"employee\"\n },\n \"seniority\": {\n \"years\": 12,\n \"months\": 2,\n \"days\": 2\n },\n \"custom_fields\": [\n {\n \"custom_field_id\": 47,\n \"custom_field_slug\": \"custom-field-001\",\n \"custom_field_name\": \"Custom Field 001\",\n \"values\": [\n {\n \"value\": \"https://www.mydomain.com/custom-fields\"\n }\n ]\n },\n {\n \"custom_field_id\": 48,\n \"custom_field_slug\": \"custom-field-002\",\n \"custom_field_name\": \"Custom-field-002\",\n \"values\": [\n {\n \"value\": \"62\"\n },\n {\n \"value\": \"64\"\n }\n ]\n },\n {\n \"custom_field_id\": 49,\n \"custom_field_slug\": \"custom-field-003\",\n \"custom_field_name\": \"Custom-field-003\",\n \"values\": [\n {\n \"value\": \"15\"\n }\n ]\n }\n ],\n \"default_avatar\": false,\n \"location_name\": \"Athens\",\n \"division_name\": \"Europe\",\n \"department_name\": \"Administration & Operations\",\n \"job_title_name\": \"Administrative Assistant\",\n \"short_manager\": {\n \"manager_id\": 1,\n \"manager_name\": \"Mia Black\",\n \"manager_employee_number\": null,\n \"location_name\": \"Athens\",\n \"department_name\": \"Administration & Operations\",\n \"division_name\": \"Europe\",\n \"job_title_name\": \"Chief Executive Officer\",\n \"linked_in_url\": null,\n \"work_phone\": \"work-phone\",\n \"email\": \"mblack@example.com\",\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1700059519_NNcbnWBX.jpg...\"\n },\n \"is_terminated\": false,\n \"user\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"middle_name\": null,\n \"email\": \"john.doe@example.com.gr\",\n \"last_login_at\": \"2023-11-15 16:47:50\"\n },\n \"hire_packet\": null,\n \"emergency_contact\": {\n \"id\": 13,\n \"employee_id\": 15,\n \"relationship_type_id\": 2,\n \"full_name\": \"Susan Doe\",\n \"phone\": \"phone-number\",\n \"address\": \"address-name\",\n \"created_at\": \"2024-02-29 11:58:38\",\n \"updated_at\": \"2024-02-29 11:58:38\",\n \"deleted_at\": null\n }\n }\n}"},{"id":"8c4a45a9-3e6e-43f2-86ee-28b7c4389ea4","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"ssn\": \"\",\n \"birth_date\": \"\",\n \"hire_date\": \"\",\n \"personal_email\": \"\",\n \"marital_status\": \"\",\n \"gender\": \"\",\n \"nationality\": \"\",\n \"citizenship\": \"\",\n \"ethnicity\": \"\",\n \"work_phone\": \"\",\n \"mobile_phone\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"country\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"reports_to_employee_id\": \"\",\n \"emergency_contact\": {\n \"full_name\": \"\",\n \"relationship_type_id\": \"\",\n \"phone\": \"\",\n \"address\": \"\"\n },\n \"linked_in_url\": \"\",\n \"is_existing\": \"\",\n \"employee_number\": \"\",\n \"passport_number\": \"\",\n \"passport_issued_date\": \"\",\n \"passport_expiry_date\": \"\",\n \"passport_issuing_country\": \"\",\n \"visa_type\": \"\",\n \"visa_number\": \"\",\n \"visa_expiry_date\": \"\",\n \"driver_license_number\": \"\",\n \"driver_license_issued_date\": \"\",\n \"driver_license_expiry_date\": \"\",\n \"driver_license_issuing_country\": \"\",\n \"sec_address\": \"\",\n \"sec_city\": \"\",\n \"sec_postal_code\": \"\",\n \"sec_country\": \"\",\n \"twitter_url\": \"\",\n \"facebook_url\": \"\",\n \"instagram_url\": \"\",\n \"pinterest_url\": \"\",\n \"github_url\": \"\",\n \"behance_url\": \"\",\n \"skype_name\": \"\",\n \"shirt_size\": \"\",\n \"t_shirt_size\": \"\",\n \"hr_languages\": [\n \"\",\n \"\"\n ],\n \"allergies\": \"\",\n \"prevent_email\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"1c019c06-2209-40a2-a5ef-76cbd98168bb","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"first_name\": \"\",\n \"last_name\": \"\",\n \"email\": \"\",\n \"ssn\": \"\",\n \"birth_date\": \"\",\n \"hire_date\": \"\",\n \"personal_email\": \"\",\n \"marital_status\": \"\",\n \"gender\": \"\",\n \"nationality\": \"\",\n \"citizenship\": \"\",\n \"ethnicity\": \"\",\n \"work_phone\": \"\",\n \"mobile_phone\": \"\",\n \"phone\": \"\",\n \"address\": \"\",\n \"country\": \"\",\n \"postal_code\": \"\",\n \"city\": \"\",\n \"reports_to_employee_id\": \"\",\n \"emergency_contact\": {\n \"full_name\": \"\",\n \"relationship_type_id\": \"\",\n \"phone\": \"\",\n \"address\": \"\"\n },\n \"linked_in_url\": \"\",\n \"is_existing\": \"\",\n \"employee_number\": \"\",\n \"passport_number\": \"\",\n \"passport_issued_date\": \"\",\n \"passport_expiry_date\": \"\",\n \"passport_issuing_country\": \"\",\n \"visa_type\": \"\",\n \"visa_number\": \"\",\n \"visa_expiry_date\": \"\",\n \"driver_license_number\": \"\",\n \"driver_license_issued_date\": \"\",\n \"driver_license_expiry_date\": \"\",\n \"driver_license_issuing_country\": \"\",\n \"sec_address\": \"\",\n \"sec_city\": \"\",\n \"sec_postal_code\": \"\",\n \"sec_country\": \"\",\n \"twitter_url\": \"\",\n \"facebook_url\": \"\",\n \"instagram_url\": \"\",\n \"pinterest_url\": \"\",\n \"github_url\": \"\",\n \"behance_url\": \"\",\n \"skype_name\": \"\",\n \"shirt_size\": \"\",\n \"t_shirt_size\": \"\",\n \"hr_languages\": [\n \"\",\n \"\"\n ],\n \"allergies\": \"\",\n \"prevent_email\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"87427fa6-389b-4472-a186-bd6231c4cae6"},{"name":"Delete an employee","id":"c2fa5e71-b249-4707-b4eb-406c1a3f77a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee","description":"

API Endpoint to delete the specified employee.

\n\n

This API endpoint facilitates the deletion of a specified employee from the system based on the provided employee ID. Upon invoking this endpoint, the system permanently removes the employee's record, along with all associated information and data stored within the system. It triggers a cascading effect that removes all associated records and data related to that employee. This includes various items such as job records, employment status, performance, review, assets,benefits information, personal documents, task assignments and any other information tied directly to the employee's profile.

\n

Before deleting the employee, the system checks if any other employees report to him/her directly. If there are, these subordinate employees are automatically reassigned to a new manager. Typically, the new manager is the supervisor of the deleted employee. This ensures that there is no disruption in the workflow and that the responsibilities of the deleted employee are seamlessly redistributed within the organization.

\n

Warning: If the employee being deleted is the head of the company, meaning they have no manager above them in the organizational hierarchy, the deletion cannot proceed.

\n

Note: Once an employee is deleted, their email address can be used on your domain again.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"0295e902-f059-42c2-9fb5-12f819497034","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"ffc75c6e-7f19-422e-adeb-8769e60ba5e9","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"ae6123cf-01c6-4644-ade9-d1057b96a961","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"c2fa5e71-b249-4707-b4eb-406c1a3f77a2"},{"name":"Terminate an employee","id":"96e0e00a-9a26-476a-a51e-de37359e68e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The date that termination takes place. The effective date must be formatted as 'YYYY-MM-DD'.\n \"termination_reason\": \"\" // The reason for the employee's dismissal. Maximum character limit: 4000 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/terminate","description":"

API Endpoint to terminate the employment of an employee.

\n\n

This API endpoint demonstrates the process of employee terminations within the HR system by incorporating the effective date of termination and the reason for termination. Users can remain active and utilize the system normally until the final termination date is specified. Upon the termination process, the system automatically assigns offboarding tasks to relevant users, ensuring a seamless transition for the terminated employee (employees are being notified also via email). If the termination date matches the current date, the user is instantly terminated, preventing further access to the system.

\n

When an employee is terminated, the system initiates several automatic procedures to ensure a smooth transition and maintain organizational integrity. Upon the employee's termination, employees who are under his/her supervision are reassigned to the manager of the terminated employee. Concurrently, any incomplete task assignments of the terminated employee are transferred to this manager as well.

\n

Furthermore, the system automatically deletes any job records, compensation records, manager records, or employment status records that are dated after the termination. Additionally, any time off requests(rejected or remain unanswered) from the terminated employee will be removed. Finally, if the terminated employee is part of a hiring team for a job position, he/she will be removed from the hiring team as part of the termination process.

\n

Note: The information of the terminated user remains within the system after the termination.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe date that an employee will be terminated. The effective date must be formatted as 'YYYY-MM-DD'.e.g. 2024-02-01
termination_reasonstringfalseThe reason for the employee's dismissal. Maximum character limit: 4000 characters.e.g. poor quality of work
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","terminate"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"35b688df-bcab-40df-a2b2-bcb1dde4c17b","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"7159e6e8-7f5f-4380-8131-b251a6fc20dd","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"termination_reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/terminate","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","terminate"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 39,\n \"employee_id\": 34,\n \"effective_date\": \"2024-03-04\",\n \"employment_status_id\": 4,\n \"is_active\": 0,\n \"end_date\": null,\n \"created_at\": \"2024-03-04 10:19:18\",\n \"updated_at\": \"2024-03-04 10:19:18\",\n \"deleted_at\": null,\n \"termination_reason\": null,\n \"employment_status\": {\n \"id\": 4,\n \"name\": \"Terminated\",\n \"object_type\": \"employment_status\"\n }\n }\n}"},{"id":"c99fbde1-91a9-435d-942d-02f4d090e62c","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"termination_reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/terminate","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","terminate"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"ae6ed676-a7b1-4040-bee3-847874742c86","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"termination_reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/terminate","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","terminate"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"96e0e00a-9a26-476a-a51e-de37359e68e6"},{"name":"Get employee's Custom Fields","id":"424e3e8c-37f6-4a41-b3a1-b279dbafc300","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/custom-fields","description":"

API Endpoint to get the custom fields that are available for an employee.

\n\n

The current endpoint facilitates the retrieval of comprehensive information regarding two distinct types of custom fields within the system: custom fields and pre-existing custom fields that are already part of the system. These custom fields offer diverse functionalities ranging from simple text inputs to complex data structures. The types of custom fields vary, including text, long text, date, multiple choice, single choice, link and employee references. Additionally, pre-existing custom fields have 'blended' choice, presenting objects with associated properties (e.g. Passport).

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","custom-fields"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"1d23e32a-b359-4cba-ba63-3f30eda12bdf","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"14029c1f-b168-4a2a-9388-f1f877bae040","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/custom-fields","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","custom-fields"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 20,\n \"name\": \"Secondary Address\",\n \"slug\": \"hr-sec-address\",\n \"custom_field_type_id\": 8,\n \"subfields\": 4,\n \"is_predefined\": true,\n \"is_enabled\": true,\n \"is_group\": true,\n \"parent_group_id\": null,\n \"visible_to\": null,\n \"has_multiple_records\": false,\n \"created_at\": \"2023-07-24 11:42:45\",\n \"updated_at\": \"2024-03-05 11:16:17\",\n \"deleted_at\": null,\n \"subfields_names\": [\n {\n \"id\": 21,\n \"name\": \"Address\",\n \"slug\": \"sec-address\",\n \"custom_field_type_id\": 1,\n \"subfields\": 0,\n \"is_predefined\": true,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": 20,\n \"visible_to\": \"both\",\n \"has_multiple_records\": false,\n \"created_at\": \"2023-07-24 11:42:45\",\n \"updated_at\": \"2024-03-05 11:16:17\",\n \"deleted_at\": null,\n \"field_name\": \"sec_address\",\n \"custom_field_values\": [],\n \"custom_field_type\": {\n \"id\": 1,\n \"slug\": \"text-field\",\n \"name\": \"Text field\"\n }\n },\n {\n \"id\": 22,\n \"name\": \"City\",\n \"slug\": \"sec-city\",\n \"custom_field_type_id\": 1,\n \"subfields\": 0,\n \"is_predefined\": true,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": 20,\n \"visible_to\": \"both\",\n \"has_multiple_records\": false,\n \"created_at\": \"2023-07-24 11:42:45\",\n \"updated_at\": \"2024-03-05 11:16:17\",\n \"deleted_at\": null,\n \"field_name\": \"sec_city\",\n \"custom_field_values\": [],\n \"custom_field_type\": {\n \"id\": 1,\n \"slug\": \"text-field\",\n \"name\": \"Text field\"\n }\n }\n ]\n },\n {\n \"id\": 16,\n \"name\": \"Address\",\n \"slug\": \"address\",\n \"custom_field_type_id\": 1,\n \"subfields\": 0,\n \"is_predefined\": true,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": 15,\n \"visible_to\": \"both\",\n \"has_multiple_records\": false,\n \"created_at\": \"2023-07-24 11:42:45\",\n \"updated_at\": \"2023-11-24 11:11:15\",\n \"deleted_at\": null,\n \"subfields_names\": [],\n \"field_name\": \"address\",\n \"custom_field_type\": {\n \"id\": 1,\n \"slug\": \"text-field\",\n \"name\": \"Text field\"\n },\n \"custom_field_values\": []\n }\n ]\n}"},{"id":"78991fbc-838b-49a5-b404-3efbd9649b99","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/custom-fields","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","custom-fields"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"424e3e8c-37f6-4a41-b3a1-b279dbafc300"},{"name":"Get employee's employment status","id":"6055dff5-e742-438e-b69a-8b7715fadcc2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","description":"

API Endpoint to retrieve the employment statuses of an employee.

\n\n

This endpoint provides comprehensive information on the employment statuses of the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","employment-statuses"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"02754942-0f3e-4277-8324-2ea37af162a6","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"66f33e8e-2c2a-415c-a032-3d4fe28e54dd","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 15,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"employment_status_id\": 1,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": null,\n \"deleted_at\": null,\n \"termination_reason\": null,\n \"employment_status\": {\n \"id\": 1,\n \"name\": \"Full-Time\"\n }\n }\n ]\n}"},{"id":"7db8b796-8c9f-404e-a805-5244e7a17eb2","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"6055dff5-e742-438e-b69a-8b7715fadcc2"},{"name":"Create an employment status","id":"801191ba-50b5-4f5d-9eba-9e6e39b2c7a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The employee must have at least one employment status record with an effective date equal to their hire date. If that, the posted effective date must be equal to or after than the employee's hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.\n \"employment_status_id\": \"\" // The id of the employment status. This must be a valid employment status from the provided 'employment-statuses' of the system.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","description":"

API Endpoint to create a new employment status for an employee.

\n\n

This endpoint enables the creation of an employment status for the specified employee. The request body should include two variables: the effective date of the status change, formatted as 'YYYY-MM-DD', and the employment status ID.

\n

It's essential to note that an employee must have at least one employment status record with an effective date matching their hire date. While creating a new employment status we have to know:

\n
    \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
  • If the specified employee is a future hire, then the effective date must come after the hire date.
    • \n
\n

Note: The employment status ID provided must be valid and correspond to one of the options available in the system's 'employment-statuses' collection.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The employee must have at least one employment status record with an effective date equal to their hire date. If that, the posted effective date must be equal to or after than the employee's hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.e.g. 2024-02-01
employment_status_idstringtrueThe id of the employment status. This must be a valid employment status from the provided 'employment-statuses' of the system.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","employment-statuses"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a2ee59f4-2cca-4f3c-8b08-be74e79ce6d0","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"0ac3a419-bac6-4096-92b7-2276173f8473","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"employment_status_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"employment_status_id\": 1,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": null,\n \"deleted_at\": null,\n \"termination_reason\": null,\n \"employment_status\": {\n \"id\": 1,\n \"name\": \"Full-Time\"\n }\n }\n}"},{"id":"8ab299bc-8303-4e45-958d-147879a83033","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"employment_status_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"fcb54588-c920-4aa6-8f16-a67f0a66e7fa","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"employment_status_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"801191ba-50b5-4f5d-9eba-9e6e39b2c7a9"},{"name":"Get an employment status record","id":"ecaf26ad-6612-405c-83f5-6f82dc064463","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","description":"

API Endpoint to retrieve a specified employment record of an employee.

\n

This endpoint retrieves a specified employment status record from the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","employment-statuses",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"39bdfca2-72dc-4fc1-a800-5e3c73905879","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"e95a4746-0a3d-40ee-a3a4-2fd67273db33","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"9d3a65de-109f-4f0b-8bda-658b9d2e3019","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"employment_status_id\": 1,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": null,\n \"deleted_at\": null,\n \"termination_reason\": null,\n \"employment_status\": {\n \"id\": 1,\n \"name\": \"Full-Time\"\n }\n }\n}"},{"id":"5555a75b-b9a5-4a02-8016-f107da5e3212","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"ecaf26ad-6612-405c-83f5-6f82dc064463"},{"name":"Update an employment status record","id":"66fcc08e-2cbf-48e9-b3b3-0cdbcc14c6b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The employee must have at least one employment status record with an effective date equal to their hire date. If that, the posted effective date must be equal to or after than the employee's hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.\n \"employment_status_id\": \"\" // The id of the employment status. This must be a valid employment status from the provided 'employment-statuses' of the system.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","description":"

API Endpoint to update the employment status of an employee.

\n

This endpoint updates the employment status for the specified employee. The request body should include two variables: the effective date of the status change, formatted as 'YYYY-MM-DD', and the employment status ID.

\n

It's essential to note that an employee must have at least one employment status record with an effective date matching their hire date. While updating an employment status we have to know:

\n
    \n

  • If only one record exist to the specified employees, any updates must be dated before today's date. Changing the date to a time before the specified hire date will adjust the employee's hire date accordingly in conjunction with the manager, job record and compensation record effective date.

    \n
    • \n

  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.

    \n
    • \n

  • if employee's contract has terminated, the employment status can not be modified.

    \n
    • \n

  • If the specified employee is a future hire, then the effective date must come after the hire date.

    \n
    • \n
\n

Note: The employment status ID provided must be valid and correspond to one of the options available in the system's 'employment-statuses' collection.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The employee must have at least one employment status record with an effective date equal to their hire date. If that, the posted effective date must be equal to or after than the employee's hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.e.g. 2024-02-01
employment_status_idstringtrueThe id of the employment status. This must be a valid employment status from the provided 'employment-statuses' of the system.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","employment-statuses",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"1a8c381a-14c0-4aa0-aaa6-97a105c01798","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"f64222fb-5d9e-48ae-935d-8d478460e0e2","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"cac5478f-7228-40d9-81a0-cab9521eeb5f","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"employment_status_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 15,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"employment_status_id\": 1,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": null,\n \"deleted_at\": null,\n \"termination_reason\": null,\n \"employment_status\": {\n \"id\": 1,\n \"name\": \"Full-Time\"\n }\n }\n}"},{"id":"8773e037-a4ab-4273-ba52-6d5a3aa6b0f6","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"employment_status_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"e30746ff-0b53-4841-abcb-58016eb61641","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"employment_status_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"66fcc08e-2cbf-48e9-b3b3-0cdbcc14c6b7"},{"name":"Delete an employment status record","id":"1cd5274a-621d-411b-b23f-c9c97b4806ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","description":"

API Endpoint to delete a specified employment status of an employee.

\n

This endpoint deletes the specified employment status record from the specified employee.

\n

It is not allowed to delete

\n
    \n
  • The current active employment status which is the unique record of employee.
    • \n
  • History Employment records. (Records which have effective date less than current employment date).
    • \n
\n

After deleting a record:

\n
    \n
  • If the deleted status record represents a future hire and there exist at least two future hire records, deleting the record that is not the most recent (equals to the current active record) will result in the removal of all scheduled tasks for the employee. Additionally, the effective dates on other records (compensation, manager and job records) with active status are going to be adjusted to align with the current active effective date.
    • \n
  • If the deleted status record is terminated status, offboarding tasks and notifications for the specified employee are deleted. In addition, performance reviews related to the current employment status, are also removed for the specified employee.
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","employment-statuses",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"d6b70091-3258-4c04-9a97-b2193f9534f0","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"d1234152-08c8-4193-bf3b-d03aa22b7bd1","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c82ba4ed-c19b-4ef6-ac88-640831c79796","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"a61d852c-89ee-43be-ba1e-6493a602a4ce","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/employment-statuses/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","employment-statuses",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"1cd5274a-621d-411b-b23f-c9c97b4806ce"},{"name":"Get employee's job-records","id":"44f9f1b1-cbbb-4984-8f77-9eead4783f25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/job-records","description":"

API Endpoint to retrieve the location, department, division, job title quadruples about the job of an employee.

\n

This endpoint provides comprehensive information on the employee job records of the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","job-records"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"f9621ae8-fcbf-400d-9887-0d9ee9f219f1","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"52d57acb-4d23-433e-a6c9-c79ae9b1a4ac","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 20,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"job_title_id\": 25,\n \"location_id\": 36,\n \"division_id\": 13,\n \"department_id\": 6,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:50:26\",\n \"deleted_at\": null,\n \"division\": {\n \"id\": 13,\n \"name\": \"Europe\"\n },\n \"department\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\"\n },\n \"location\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"field_data\": {\n \"address\": \"1, Random Street, Athens, Greece 10551\",\n \"is_remote\": false\n }\n },\n \"job_title\": {\n \"id\": 25,\n \"name\": \"Administrative Assistant\"\n }\n }\n ]\n}"},{"id":"11b3f47e-e076-4562-a9cd-e35f48c528c9","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"44f9f1b1-cbbb-4984-8f77-9eead4783f25"},{"name":"Create a job record","id":"f3cdcfd1-2a24-4b1c-b7f6-c2eb31a5b5a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.\n \"location_id\": \"\", // The id of the location. This must be a valid location from the provided 'locations' of the system.\n \"department_id\": \"\", // The id of the department. This must be a valid department from the provided 'departments' of the system.\n \"division_id\": \"\", // The id of the division. This must be a valid division from the provided 'divisions' of the system.\n \"job_title_id\": \"\" // The id of the job title. This must be a valid job title from the provided 'job-titles' of the system.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/job-records","description":"

API Endpoint to create a new quadruple of location, department, division, job title for an employee.

\n

This endpoint enables the creation of a job record for the specified employee. The request body should include these variables: the effective date of the record, formatted as 'YYYY-MM-DD', and the location, division, department, and job_title ID.

\n

While creating a new job record we have to know:

\n
    \n
  • The new job record must have a date equal to or later than the employee's hire date.
    • \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
\n

Note: The location, division, department, and job_title ID provided must be valid and correspond to one of the options available in the system's collection.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.e.g. 2024-02-01
location_idintegerfalseThe id of the location. This must be a valid id from the provided 'locations' of the system.-
division_idintegerfalseThe id of the division. This must be a valid id from the provided 'divisions' of the system.-
department_idintegerfalseThe id of the department. This must be a valid id from the provided 'departments' of the system.-
job_title_idintegerfalseThe id of the job title. This must be a valid id from the provided 'job-titles' of the system.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","job-records"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"d6b2b125-6123-4aff-9c2b-264d22c9b481","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"92a5f5f8-fc90-47c8-8cab-4507e63b466d","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"location_id\": \"\",\n \"department_id\": \"\",\n \"division_id\": \"\",\n \"job_title_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 20,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"job_title_id\": 25,\n \"location_id\": 36,\n \"division_id\": 13,\n \"department_id\": 6,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:50:26\",\n \"deleted_at\": null,\n \"division\": {\n \"id\": 13,\n \"name\": \"Europe\"\n },\n \"department\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\"\n },\n \"location\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"field_data\": {\n \"address\": \"1, Random Street, Athens, Greece 10551\",\n \"is_remote\": false\n }\n },\n \"job_title\": {\n \"id\": 25,\n \"name\": \"Administrative Assistant\"\n }\n }\n}"},{"id":"0e472050-1d76-4d2d-92cc-98bf7119bbca","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"location_id\": \"\",\n \"department_id\": \"\",\n \"division_id\": \"\",\n \"job_title_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"22089239-1a1e-43c3-be1f-2004a1020e31","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"location_id\": \"\",\n \"department_id\": \"\",\n \"division_id\": \"\",\n \"job_title_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"f3cdcfd1-2a24-4b1c-b7f6-c2eb31a5b5a4"},{"name":"Get a job record","id":"bea6d2a0-b237-47c0-8d46-08be1bcc6df3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/job-records/:objectId","description":"

API Endpoint to retrieve the specified job record of an employee.

\n

This endpoint retrieves a job record for the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","job-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"56263b13-6838-4fdf-8c5f-441ae69dd7a2","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"cab59d7e-d333-463f-b4cc-1efb6273f0c4","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"129f9b68-c547-4970-bab9-c44fa42222c6","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 20,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"job_title_id\": 25,\n \"location_id\": 36,\n \"division_id\": 13,\n \"department_id\": 6,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:50:26\",\n \"deleted_at\": null,\n \"division\": {\n \"id\": 13,\n \"name\": \"Europe\"\n },\n \"department\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\"\n },\n \"location\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"field_data\": {\n \"address\": \"1, Random Street, Athens, Greece 10551\",\n \"is_remote\": false\n }\n },\n \"job_title\": {\n \"id\": 25,\n \"name\": \"Administrative Assistant\"\n }\n }\n}"},{"id":"75b994dd-efdc-4fa5-8853-696e57bd84a7","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"bea6d2a0-b237-47c0-8d46-08be1bcc6df3"},{"name":"Update a job record","id":"ded6f818-f9c2-4ebe-81bc-0d13c4e6d827","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.\n \"location_id\": \"\", // The id of the location. This must be a valid location from the provided 'locations' of the system.\n \"department_id\": \"\", // The id of the department. This must be a valid department from the provided 'departments' of the system.\n \"division_id\": \"\", // The id of the division. This must be a valid division from the provided 'divisions' of the system.\n \"job_title_id\": \"\" // The id of the job title. This must be a valid job title from the provided 'job-titles' of the system.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/job-records/:objectId","description":"

API Endpoint to update a specified job record of an employee.

\n

This endpoint updates a job record for the specified employee. The request body should include these variables: the effective date of the record, formatted as 'YYYY-MM-DD', and the location, division, department, and job_title ID.

\n

While creating a new job record we have to know:

\n
    \n
  • The effective date must be equal to or later than the employee's hire date.
    • \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
\n

Considering changes of the job record of employee, the system will be add or remove the performance reviews coresponding to the new data.

\n

Note: The location, division, department, and job_title ID provided must be valid and correspond to one of the options available in the system's collection.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.e.g. 2024-02-01
location_idintegerfalseThe id of the location. This must be a valid location from the provided 'locations' of the system.-
division_idintegerfalseThe id of the division. This must be a valid division from the provided 'divisions' of the system.-
department_idintegerfalseThe id of the department. This must be a valid department from the provided 'departments' of the system.-
job_title_idintegerfalseThe id of the job title. This must be a valid job title from the provided 'job-titles' of the system.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","job-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"40871486-2214-4b0f-b436-a10aa3c937fb","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"2cb28793-2626-43d3-8adf-89779bb24bd4","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c93630cc-5542-450e-9248-50d847506a13","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"location_id\": \"\",\n \"department_id\": \"\",\n \"division_id\": \"\",\n \"job_title_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 20,\n \"employee_id\": 15,\n \"effective_date\": \"2012-01-02\",\n \"job_title_id\": 25,\n \"location_id\": 36,\n \"division_id\": 13,\n \"department_id\": 6,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:50:26\",\n \"deleted_at\": null,\n \"division\": {\n \"id\": 13,\n \"name\": \"Europe\"\n },\n \"department\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\"\n },\n \"location\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"field_data\": {\n \"address\": \"1, Random Street, Athens, Greece 10551\",\n \"is_remote\": false\n }\n },\n \"job_title\": {\n \"id\": 25,\n \"name\": \"Administrative Assistant\"\n }\n }\n}"},{"id":"c7078be0-bb63-4457-b143-3a6c7eebbd45","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"location_id\": \"\",\n \"department_id\": \"\",\n \"division_id\": \"\",\n \"job_title_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"f6920918-b111-41c9-92c2-8c4944617f1c","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"location_id\": \"\",\n \"department_id\": \"\",\n \"division_id\": \"\",\n \"job_title_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"ded6f818-f9c2-4ebe-81bc-0d13c4e6d827"},{"name":"Delete a job record","id":"8dad9e11-6510-414f-a864-bbdf28f27964","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/job-records/:objectId","description":"

API Endpoint to delete a specified job record of an employee.

\n

This endpoint deletes the specified job record for the specified employee.

\n

It is not allowed to delete :

\n
    \n
  • History job records (Records which have effective date less than current job.)
    • \n
\n

After deleting a specific job record, the system will be remove the performance reviews coresponding to the new data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","job-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"23fdcfaa-e03a-4025-98e5-e9e24ad7f8fd","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"da80059b-1a37-400f-8624-13b2a6a318c4","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"cf7347b2-5d7c-4628-9a95-8f972b7a5cd4","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"fd072949-1461-4c29-a118-df92a45346a8","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/jobRecords/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","jobRecords",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"8dad9e11-6510-414f-a864-bbdf28f27964"},{"name":"Get employee job info","id":"8b799f5a-3bf1-49de-9596-7c93bb9a0ab1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/job","description":"

API Endpoint to retrieve the job information of an employee.

\n

This endpoint provides a comprehensive overview of job-related information for the employee. This includes employment status history, job records, compensation records, manager records, and benefits related to the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","job"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"3007459b-17db-4e8c-842a-95e46f2a8d75","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"f2e7f4f1-0b7a-4757-a682-0b12f4882e60","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/job","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","job"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"employment_statuses\": [\n {\n \"id\": 1,\n \"employee_id\": 1,\n \"effective_date\": \"2012-01-02\",\n \"employment_status_id\": 1,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 13:56:10\",\n \"updated_at\": \"2023-11-15 14:28:22\",\n \"deleted_at\": null,\n \"termination_reason\": null,\n \"employment_status\": {\n \"id\": 1,\n \"name\": \"Full-Time\",\n \"object_type\": \"employment_status\"\n }\n }\n ],\n \"manager_records\": [\n {\n \"id\": 53,\n \"employee_id\": 1,\n \"reports_to_employee_id\": 43,\n \"effective_date\": \"2024-02-29\",\n \"end_date\": null,\n \"from_id\": null,\n \"created_at\": \"2024-02-29 11:45:54\",\n \"updated_at\": \"2024-03-04 10:41:07\",\n \"deleted_at\": null,\n \"manager\": {\n \"id\": 43,\n \"user_id\": 45,\n \"user\": {\n \"id\": 45,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n },\n {\n \"id\": 51,\n \"employee_id\": 1,\n \"reports_to_employee_id\": 42,\n \"effective_date\": \"2024-02-29\",\n \"end_date\": \"2024-02-29\",\n \"from_id\": null,\n \"created_at\": \"2024-02-29 10:43:22\",\n \"updated_at\": \"2024-02-29 10:43:22\",\n \"deleted_at\": null,\n \"manager\": null\n }\n ],\n \"job_records\": [\n {\n \"id\": 18,\n \"employee_id\": 1,\n \"effective_date\": \"2023-11-15\",\n \"job_title_id\": 18,\n \"location_id\": 36,\n \"division_id\": 13,\n \"department_id\": 6,\n \"end_date\": null,\n \"created_at\": \"2023-11-15 14:45:24\",\n \"updated_at\": \"2023-11-15 14:45:24\",\n \"deleted_at\": null,\n \"location\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\",\n \"field_data\": {\n \"address\": \"address-name\",\n \"is_remote\": false\n }\n },\n \"division\": {\n \"id\": 13,\n \"name\": \"Europe\",\n \"object_type\": \"division\"\n },\n \"department\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n },\n \"job_title\": {\n \"id\": 18,\n \"name\": \"Chief Executive Officer\",\n \"object_type\": \"job-title\"\n }\n }\n ],\n \"compensation_records\": [\n {\n \"id\": 19,\n \"employee_id\": 1,\n \"effective_date\": \"2023-05-15\",\n \"pay_rate_currency\": \"EUR\",\n \"pay_rate\": \"14316.70\",\n \"pay_rate_period\": \"month\",\n \"custom_pay_rate_period\": null,\n \"pay_schedule\": \"twice-per-month\",\n \"overtime_status\": \"exempt\",\n \"end_date\": null,\n \"created_at\": \"2024-01-09 07:28:04\",\n \"updated_at\": \"2024-01-15 11:41:50\",\n \"deleted_at\": null,\n \"change_reason\": null\n }\n ],\n \"benefits\": [\n {\n \"id\": 1,\n \"name\": \"Health Insurance\",\n \"description\": null,\n \"cost\": null,\n \"cost_currency\": \"EUR\",\n \"cost_period\": null,\n \"required_for_all\": true,\n \"benefit_category_id\": null,\n \"created_at\": \"2023-11-15 13:56:11\",\n \"updated_at\": \"2024-01-15 11:41:50\",\n \"deleted_at\": null,\n \"start_date\": \"2012-01-02\",\n \"end_date\": null,\n \"benefit_category\": null,\n \"benefit_required_for\": []\n }\n ]\n }\n}"},{"id":"b04b49b8-27e7-444e-ab19-5e75041bba04","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/job","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","job"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"8b799f5a-3bf1-49de-9596-7c93bb9a0ab1"},{"name":"Get employee's managers","id":"e8816c2b-22f2-4a0e-b329-aa841d42261c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/managers","description":"

API Endpoint to retrieve information about the managers of an employee.

\n

This endpoint provides comprehensive information on the employee's manager records for the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","managers"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"6c05e0c8-ab36-437d-a722-6fe18ebfb2dd","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"86af40d8-245d-4b24-a23e-41c510e26e13","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 18,\n \"employee_id\": 15,\n \"reports_to_employee_id\": 1,\n \"effective_date\": \"2012-01-02\",\n \"end_date\": null,\n \"from_id\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:45:25\",\n \"deleted_at\": null,\n \"manager\": {\n \"id\": 1,\n \"user_id\": 1,\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n }\n ]\n}"},{"id":"207f9147-a056-46e5-9a15-8716beb0f85f","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"e8816c2b-22f2-4a0e-b329-aa841d42261c"},{"name":"Create a manager record","id":"756d1f43-55a9-44c4-b338-b83195310014","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must before or equal of the current date and after or equal employee's hire date. If the current employee is a future hire, you cannot assign them any manager until after their hire date.\n \"reports_to_employee_id\": \"\" // The employee Id (Active employee) that is goint to be the manager of the specified employee.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/managers","description":"

API Endpoint to create a manager record for an employee.

\n

This endpoint enables the creation of a manager record for the specified employee. The request body should include these variables: the effective date of the record, formatted as 'YYYY-MM-DD', and the manager's employee ID.

\n

When we are creating a manager record, we should avoid creating loops or circles in the organization hierarchy.

\n

It's essential to note that an employee must have at least one manager record with an effective date matching their hire date. While creating a new manager record we have to know:

\n
    \n
  • The effective date must be after or equal of employee's hire date.
    • \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
  • If the specified employee is a future hire, then you cannot assign them any manager until after their hire date.
    • \n
  • The person that is going to be the manager of the specified employee must be an active employee.
    • \n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'.
The date must before or equal of the current date and after or equal employee's hire date. If the current employee is a future hire, you cannot assign them any manager until after their hire date.		e.g. 2024-07-01
reports_to_employee_idintegertrueThe employee ID (Active employee) that is going to be the manager of the specified employee.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","managers"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"934ac7e0-78bf-40cd-a11a-c809273ba5c0","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"ecc66715-12a1-462d-905c-3b29c4919ca0","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"reports_to_employee_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 18,\n \"employee_id\": 15,\n \"reports_to_employee_id\": 1,\n \"effective_date\": \"2012-01-02\",\n \"end_date\": null,\n \"from_id\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:45:25\",\n \"deleted_at\": null,\n \"manager\": {\n \"id\": 1,\n \"user_id\": 1,\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n }\n}"},{"id":"bd642e4e-9cd5-486a-8ccc-cab5e9a41b90","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"reports_to_employee_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"aa954376-7112-4fb7-9c38-08c392015471","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"reports_to_employee_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"756d1f43-55a9-44c4-b338-b83195310014"},{"name":"Get employee's compensation-records","id":"4cf608d6-55e0-43ac-a7b1-aeb45ad1d9a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","description":"

API Endpoint to retrieve information about the compensation of an employee.

\n

This endpoint provides comprehensive information on the employee compensation records of the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","compensation-records"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"e667ffaf-844d-437b-8536-00eb1dfb8700","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"c003687a-7cf1-492d-b427-be838ab6089c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 30,\n \"employee_id\": 15,\n \"effective_date\": \"2024-03-01\",\n \"pay_rate_currency\": \"EUR\",\n \"pay_rate\": \"1000.00\",\n \"pay_rate_period\": \"month\",\n \"custom_pay_rate_period\": null,\n \"pay_schedule\": \"once-per-month\",\n \"overtime_status\": \"exempt\",\n \"end_date\": null,\n \"created_at\": \"2024-03-01 09:09:04\",\n \"updated_at\": \"2024-03-01 09:09:04\",\n \"deleted_at\": null,\n \"change_reason\": \"N/A\"\n }\n ]\n}"},{"id":"4bba4491-29f7-4820-abd4-2e9299841215","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"4cf608d6-55e0-43ac-a7b1-aeb45ad1d9a1"},{"name":"Create a compensation record","id":"002626c5-7b14-4842-80c4-a7cf5255e660","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // (Required) The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.\n \"pay_rate_period\": \"\", // (Required) Valid values [hour, day, week, month, quarter, year]. This is the period over which money is earned.\n \"pay_rate\": \"\", // This is the employee's wage. Allow 2 decimal places e.g 1203.55\n \"pay_schedule\": \"\", // Valid values [once-per-month, twice-per-month, every-other-week]. This is the frequency of the wage.\n \"overtime_status\": \"\", // Valid values [exempt, non-exempt]. This determines whether an employee is exempt or non-exempt from overtime regulations.\n \"change_reason\": \"\" // Valid values ['N/A', 'annual-pay', 'increase', 'promotion', 'relocation', 'title-change']. This is the reason of compensation change.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","description":"

API Endpoint to create a new compensation record for an employee.

\n

This endpoint enables the creation of a compensation record for the specified employee. The request body should include these variables: the effective date of the record, formatted as 'YYYY-MM-DD', the pay rate, pay rate period, pay schedule, and overtime status.

\n

While creating a new compensation record we have to know:

\n
    \n
  • The new compensation record must have a date equal to or later than the employee's hire date.
    • \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'.
The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.
pay_rate_periodstringtrueThis is the period over which money is earned.
Valid values are
['hour', 'day', 'week', 'month', 'quarter', 'year']		e.g. month
pay_ratenumberfalseThis is the employee's wage and must have 2 decimalse.g. 1203.72
pay_schedulestringfalseThis is the frequency of the wage.
Valid values are
['once-per-month',' twice-per-month', 'every-other-week']		e.g. twice-per-month
overtime_statusstringfalseThis determines whether an employee is exempt or non-exempt from overtime regulations.
Valid values are
['exempt, non-exempt','non-exempt']		e.g. exempt
change_reasonstringfalseThis is the reason of compensation change.
Valid values are
['N/A', 'annual-pay', 'increase', 'promotion', 'relocation', 'title-change']		e.g. promotion
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","compensation-records"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a08e6d77-6e90-4645-a576-783542ceaf71","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"1f313a3f-7640-4fb9-ba74-e3ff4e9984ef","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate\": \"\",\n \"pay_schedule\": \"\",\n \"overtime_status\": \"\",\n \"change-reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 30,\n \"employee_id\": 15,\n \"effective_date\": \"2024-03-01\",\n \"pay_rate_currency\": \"EUR\",\n \"pay_rate\": \"1000.00\",\n \"pay_rate_period\": \"month\",\n \"custom_pay_rate_period\": null,\n \"pay_schedule\": \"once-per-month\",\n \"overtime_status\": \"exempt\",\n \"end_date\": null,\n \"created_at\": \"2024-03-01 09:09:04\",\n \"updated_at\": \"2024-03-01 09:09:04\",\n \"deleted_at\": null,\n \"change_reason\": \"N/A\"\n }\n}"},{"id":"7d26e80c-34ff-4c79-9330-cb6930c68a6e","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate\": \"\",\n \"pay_schedule\": \"\",\n \"overtime_status\": \"\",\n \"change-reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"f63d7465-6dff-4ede-8c90-e15034cbe4ab","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate\": \"\",\n \"pay_schedule\": \"\",\n \"overtime_status\": \"\",\n \"change-reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"002626c5-7b14-4842-80c4-a7cf5255e660"},{"name":"Get a compensation record","id":"81061a3b-3617-45f7-be09-f89fe1184915","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","description":"

API Endpoint to retrieve a specified compensation record of an employee.

\n

This endpoint retrieves the compensation data for the specified employee. To use this endpoint , the Employee id and the compensation record id must be specified.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","compensation-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"21ae17fa-7d89-4c45-8d6d-0ae8eb90715f","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"f554d1f0-d313-4ba2-bae0-c0e38040fad5","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"4f79224a-4e39-4196-916c-35e5174a40ea","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 30,\n \"employee_id\": 15,\n \"effective_date\": \"2024-03-01\",\n \"pay_rate_currency\": \"EUR\",\n \"pay_rate\": \"1000.00\",\n \"pay_rate_period\": \"month\",\n \"custom_pay_rate_period\": null,\n \"pay_schedule\": \"once-per-month\",\n \"overtime_status\": \"exempt\",\n \"end_date\": null,\n \"created_at\": \"2024-03-01 09:09:04\",\n \"updated_at\": \"2024-03-01 09:09:04\",\n \"deleted_at\": null,\n \"change_reason\": \"N/A\"\n }\n}"},{"id":"8299c495-0a4c-4035-8bb8-4ddafe56e805","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"81061a3b-3617-45f7-be09-f89fe1184915"},{"name":"Update a compensation record","id":"642b57c3-885b-44d7-bacf-6d2b56d800e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // (Required) The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'. The date must be equal to or after than the hire date.. If a termination date is specified for the current employee, the effective date must come before the termination date.\n \"pay_rate_period\": \"\", // (Required) Valid values [hour, day, week, month, quarter, year]. This is the period over which money is earned.\n \"pay_rate\": \"\", // This is the employee's wage. Allow 2 decimal places e.g 1203.55\n \"pay_schedule\": \"\", // Valid values [once-per-month, twice-per-month, every-other-week]. This is the frequency of the wage.\n \"overtime_status\": \"\", // Valid values [exempt, non-exempt]. This determines whether an employee is exempt or non-exempt from overtime regulations.\n \"change_reason\": \"\" // Valid values ['N/A', 'annual-pay', 'increase', 'promotion', 'relocation', 'title-change']. This is the reason of compensation change.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","description":"

API Endpoint to update the compensation record of an employee.

\n

This endpoint updates a job record for the specified employee. The request body should include these variables: the effective date of the record, formatted as 'YYYY-MM-DD', the pay rate, pay rate period, pay schedule, overtime status, and the reason of change.

\n

While creating a new compensation record we have to know:

\n
    \n
  • The effective date must have a date equal to or later than the employee's hire date.
    • \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'.
The date must be equal to or after than the hire date. If a termination date is specified for the current employee, the effective date must come before the termination date.		e.g. 2024-02-01
pay_rate_periodstringtrueThis is the period over which money is earned.
Valid values are
['hour', 'day', 'week', 'month', 'quarter', 'year']		e.g. hour
pay_ratenumberfalseThis is the employee's wage and must have 2 decimalse.g. 1203.72
pay_schedulestringfalseThis is the frequency of the wage.
Valid values are
['once-per-month',' twice-per-month', 'every-other-week']		e.g. twice-per-month
overtime_statusstringfalseThis determines whether an employee is exempt or non-exempt from overtime regulations.
Valid values are
['exempt, 'non-exempt']		e.g. exempt
change_reasonstringfalseThis is the reason of compensation change.
Valid values are
['N/A', 'annual-pay', 'increase', 'promotion', 'relocation', 'title-change']		e.g. N/A
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","compensation-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"2f43f275-1225-4596-9211-7f9fea92a408","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"50c828f1-e9a6-4781-88ee-b02bec046516","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"aab56aff-a5ad-4e24-9749-b5f51c21795a","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate\": \"\",\n \"pay_schedule\": \"\",\n \"overtime_status\": \"\",\n \"change-reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 30,\n \"employee_id\": 15,\n \"effective_date\": \"2024-03-01\",\n \"pay_rate_currency\": \"EUR\",\n \"pay_rate\": \"1000.00\",\n \"pay_rate_period\": \"month\",\n \"custom_pay_rate_period\": null,\n \"pay_schedule\": \"once-per-month\",\n \"overtime_status\": \"exempt\",\n \"end_date\": null,\n \"created_at\": \"2024-03-01 09:09:04\",\n \"updated_at\": \"2024-03-01 09:09:04\",\n \"deleted_at\": null,\n \"change_reason\": \"N/A\"\n }\n}"},{"id":"a0e01025-c898-4b45-bbfe-adc911427a9a","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate\": \"\",\n \"pay_schedule\": \"\",\n \"overtime_status\": \"\",\n \"change-reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"5b6925dc-88d0-4e08-ada4-5e9b2782a8dd","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"pay_rate_period\": \"\",\n \"pay_rate\": \"\",\n \"pay_schedule\": \"\",\n \"overtime_status\": \"\",\n \"change-reason\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"642b57c3-885b-44d7-bacf-6d2b56d800e6"},{"name":"Delete a compensation record","id":"7e2b70bf-da16-4b2d-9c29-a3001bd266a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","description":"

API Endpoint to delete a compensation record of an employee.

\n

This endpoint deletes the specified compensation record of the specified employee.

\n

If employee's contract has terminated, it is not allowed to delete the compensation record.

\n

Also it is not allowed to delete:

\n
    \n
  • History compensation records (Records which have effective date less than current compensation.)
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","compensation-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"2c7228df-7c6c-4848-ad41-a31dc8436908","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"a9e4088b-094b-4392-a1d9-1a62ec74bf56","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"8bed17be-87c8-4dda-9b1e-945c4fa04cc9","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"08c922cb-0089-497a-966d-2a3210caa326","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/compensation-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","compensation-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"7e2b70bf-da16-4b2d-9c29-a3001bd266a2"},{"name":"Get employee's benefits","id":"829206cf-5527-4408-9c66-150ac04cb761","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/benefits","description":"

API Endpoint to retrieve information about the benefits that an employee has.

\n

This endpoint returns comprehensive information on benefits for the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","benefits"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"0d7f718a-6350-4f2a-869a-554bcdaf0597","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"f3ad1a83-95af-4015-add3-7d3b7ff99195","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/benefits","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","benefits"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"benefit-name\",\n \"description\": null,\n \"cost\": null,\n \"cost_currency\": \"EUR\",\n \"cost_period\": null,\n \"required_for_all\": false,\n \"benefit_category_id\": 1,\n \"created_at\": \"2023-11-16 07:48:58\",\n \"updated_at\": \"2024-03-01 10:49:45\",\n \"deleted_at\": null,\n \"start_date\": \"2024-02-01\",\n \"end_date\": null,\n \"benefit_category\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\"\n },\n \"benefit_required_for\": [\n {\n \"id\": 8,\n \"benefit_id\": 2,\n \"object_id\": 1,\n \"required_for_type\": \"employment_status\",\n \"created_at\": \"2024-03-01 10:11:44\",\n \"updated_at\": \"2024-03-01 10:11:44\",\n \"deleted_at\": null,\n \"object_name\": \"Full-Time\",\n \"employee_custom_field\": {\n \"id\": 1,\n \"name\": \"Full-Time\",\n \"object_type\": \"employment_status\"\n }\n }\n ]\n }\n ]\n}"},{"id":"e37270cf-5bc4-41e8-af8f-4a8649882eea","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/benefits","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","benefits"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"829206cf-5527-4408-9c66-150ac04cb761"},{"name":"Get employee's documents","id":"25efd277-dc78-4e91-87e5-6110a9ad2afe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/documents","description":"

API Endpoint to retrieve employee's document.

\n

This endpoint returns comprehensive information on private documents for the specified employee. Some people within a company have the legal right to view personnel files. These people are the Company Administrator and the Hr manager of the organization.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","documents"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"44f56676-85b0-4c2c-93fc-852d41bc2d7c","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"f5c8a3b2-13b0-4982-8603-aef53c33a213","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/documents","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","documents"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"uploaded_id\": 1,\n \"client_filename\": \"poster.png\",\n \"filename\": \"/testdomain/documents/NNcbnWBX/1702300272_poster.png\",\n \"filetype\": \"png\",\n \"is_employee_file\": false,\n \"is_public\": false,\n \"sort_order\": 0,\n \"created_at\": \"2023-11-16 07:33:51\",\n \"updated_at\": \"2024-02-13 11:51:33\",\n \"deleted_at\": null,\n \"owner_id\": 1,\n \"master_id\": null,\n \"preview_filename\": null,\n \"url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/documents/NNcbnWBX/1702300272_poster123.png?Expires=1707829193&Signature=wkZyul7nfEfVUbePUrTLF3B0qabz~dhNObNz-X9115lsH9hkRC6WyWoKdlqL1uBMb9lUBvIhWD1-MO2td-moqjqZcI5Lny1VpN55B3PmkBzjlOPljdneURRKm2bqeTOcjhp7cg9wKByrMHRMzZAX3CZdWsE3ZTpoJ7rMDYEyLST6tmHbyJ12ouDHpicbl75gd3lcE3PbXlm9nmy6q5NJkOIpBnCnWXfQLJ58exXzskCAz7Rm1EkSL0YXEzPVceZHPl62VWN9qwwczM6cQw1MYAUGUR8edD0DARi94eYEU-3Y6BnhPaV-gd6Gw5cmyVyupg55FHstnMJGfpCsOo6cmw__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"preview_url\": null\n }\n ]\n}"},{"id":"ea7735d0-785f-4663-9e30-b88a03aa43f4","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/documents","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","documents"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"25efd277-dc78-4e91-87e5-6110a9ad2afe"},{"name":"Upload an employee's document","id":"e785c9aa-76c8-49ef-be26-b68885d4a7dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"document","description":"

File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv). The document must not surpass 30MB.

\n","type":"file","value":null}]},"url":"https://pubapi.talenthr.io/v1/employees/:employee/documents","description":"

API Endpoint to upload a document in an employee’s folder.

\n

This endpoint facilitates the uploading of documents to the specified employee's private folder. Valid document formats include docx, doc, odt, odp, ods, xls, xlsx, ppt, pptx, pdf, png, jpg, jpeg, svg, csv, gif, webp, and tsv. The documents are exclusively accessible to the employee and are not visible to other employees. Also the Company Administrator and the Hr manager of the organization have access to the employees documents. The current document must not surpass 30MB.

\n
\n

Filenames within the system must not start with any illegal character or symbol (e.g. @ (at sign), $ (dollar sign), % (percent), & (ampersand)) and should maintain a reasonable length, ensuring they do not exceed 250 characters.

\n
\n

Request parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
documentfiletrueFile. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv). The current document must not surpass 30MB.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","documents"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"388e3299-0f19-49ff-bbc6-663a72acd76c","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"b6068cac-9777-4f71-9478-abd2f1d865aa","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"documents","value":"[\"\",\"\"]","description":"File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv)","type":"text"}]},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/documents","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","documents"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"uploaded_id\": 1,\n \"client_filename\": \"poster.png\",\n \"filename\": \"/testdomain/documents/NNcbnWBX/1702300272_poster.png\",\n \"filetype\": \"png\",\n \"is_employee_file\": false,\n \"is_public\": false,\n \"sort_order\": 0,\n \"created_at\": \"2024-02-13 07:33:51\",\n \"updated_at\": \"2024-02-13 07:33:51\",\n \"deleted_at\": null,\n \"owner_id\": 1,\n \"master_id\": null,\n \"preview_filename\": null\n }\n}"},{"id":"8225d2bc-9cbe-4c5e-9937-ef491863b1cd","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"documents","value":"[\"\",\"\"]","description":"File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv)","type":"text"}]},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/documents","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","documents"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"cdf9a1cf-b8a2-47d7-910b-a1388af928d1","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"documents","value":"[\"\",\"\"]","description":"File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv)","type":"text"}]},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/documents","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","documents"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"e785c9aa-76c8-49ef-be26-b68885d4a7dc"},{"name":"Get employee's pending tasks","id":"e90d17c5-0e6b-47ad-b69b-96048515126d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/tasks/pending?limit=&offset=&order=&sort=","description":"

API Endpoint to retrieve the pending tasks of an employee.

\n

This endpoint retrieves comprehensive information regarding pending tasks assigned to the specified employee. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, users can customize the order and sorting of the retrieved data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","tasks","pending"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum ['id', 'name', 'deadline_due_date', 'task_for']

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[{"id":"2298ad90-5250-4d00-a98c-09812c179177","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"ddc37247-0b9c-4ee8-b27b-461bd4f36dfc","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/tasks/pending?limit=&offset=&order=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","tasks","pending"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 44,\n \"task_id\": 5,\n \"employee_id\": 15,\n \"task_for_id\": 44,\n \"name\": \"Introduction to Team and Networking\",\n \"description\": \"Facilitate introductions between new hires and their team members. Encourage team-building activities and create opportunities for networking within the organization. This helps foster a sense of belonging and collaboration.\",\n \"task_type_id\": 2,\n \"task_category_id\": null,\n \"due_date_period\": \"Days\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 5,\n \"done\": false,\n \"done_at\": null,\n \"deadline_due_date\": \"2024-03-10\",\n \"employment_status_record_id\": null,\n \"created_at\": \"2024-03-05 09:41:20\",\n \"updated_at\": \"2024-03-05 10:37:59\",\n \"deleted_at\": null,\n \"course_id\": null,\n \"asset_id\": 7,\n \"task_for\": \"Doe Freddy\",\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n },\n \"task_category\": null,\n \"asset\": {\n \"id\": 7,\n \"name\": \"Membership 1\"\n },\n \"complete\": true\n }\n ]\n }\n}"},{"id":"6ecd82fc-baf2-425f-a4ad-9204d37c70f3","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/tasks/pending?limit=&offset=&order=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","tasks","pending"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"e90d17c5-0e6b-47ad-b69b-96048515126d"},{"name":"Get employee's completed tasks","id":"d548c77b-91eb-43ba-98bf-a04dfbb43e5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/tasks/completed?limit=&offset=&order=&sort=","description":"

API Endpoint to retrieve the completed tasks of an employee.

\n

This endpoint retrieves comprehensive information regarding completed tasks assigned to the specified employee. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, you can customize the order and sorting of the retrieved data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","tasks","completed"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum ['id', 'name', 'deadline_due_date', 'task_for']

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[{"id":"b2a3e0dc-35fd-4018-954d-342110fe358f","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"84b9b146-21c6-40c1-8a67-c74775a9aa6c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/tasks/completed?limit=&offset=&order=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","tasks","completed"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 44,\n \"task_id\": 5,\n \"employee_id\": 15,\n \"task_for_id\": 44,\n \"name\": \"Introduction to Team and Networking\",\n \"description\": \"Facilitate introductions between new hires and their team members. Encourage team-building activities and create opportunities for networking within the organization. This helps foster a sense of belonging and collaboration.\",\n \"task_type_id\": 2,\n \"task_category_id\": null,\n \"due_date_period\": \"Days\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 5,\n \"done\": true,\n \"done_at\": \"2024-03-05\",\n \"deadline_due_date\": \"2024-03-10 12:00:00\",\n \"employment_status_record_id\": null,\n \"created_at\": \"2024-03-05 09:41:20\",\n \"updated_at\": \"2024-03-05 10:37:59\",\n \"deleted_at\": null,\n \"course_id\": null,\n \"asset_id\": 7,\n \"task_for\": \"Doe Freddy\",\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n },\n \"task_category\": null,\n \"asset\": {\n \"id\": 7,\n \"name\": \"Membership 1\"\n }\n }\n ]\n }\n}"},{"id":"da2b8ceb-c79d-447b-8161-a80d8d7e1e0a","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/tasks/completed?limit=&offset=&order=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","tasks","completed"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"d548c77b-91eb-43ba-98bf-a04dfbb43e5d"},{"name":"Toggle employee's task","id":"51395a57-9b3b-42ec-9044-e826f32f3fc1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"\" // (Required) The status of the task assignment. 'true' to state the task as completed, 'false' for pending\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/task-assignments/:objectId","description":"

API Endpoint to mark a task of an employee as completed/incomplete.

\n

This endpoint toggles a task assignment as a pending task or completed task for the specified employee. If the task is associated with a TalentLMS training course, it cannot be marked as complete or incomplete. Additionally, if the task involves an asset, the asset will only be assigned to the employee after the task is completed. However, if a task transitions from completed to pending status, any assets previously connected to the employee will be absolved.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
statusbooleantrueThe status of the task assignment. 'true' to state the task as completed, 'false' for pending. If the task is connected with TalentLMS training then
it cannot be mark as complete or incomplete.		e.g. true
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","task-assignments",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"8a6f5355-dddd-4f3c-b498-43a056ef9d26","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"3787d460-55bf-43f6-9ae0-15fb87d7ee4e","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"3d74a34e-7dff-46cd-9c99-c87ce7c6944c","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/task-assignments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","task-assignments",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 44,\n \"task_id\": 5,\n \"employee_id\": 15,\n \"task_for_id\": 44,\n \"name\": \"Introduction to Team and Networking\",\n \"description\": \"Facilitate introductions between new hires and their team members. Encourage team-building activities and create opportunities for networking within the organization. This helps foster a sense of belonging and collaboration.\",\n \"task_type_id\": 2,\n \"task_category_id\": null,\n \"due_date_period\": \"Days\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 5,\n \"done\": true,\n \"done_at\": \"2024-03-05 12:52:50\",\n \"deadline_due_date\": \"2024-03-10\",\n \"employment_status_record_id\": null,\n \"created_at\": \"2024-03-05 09:41:20\",\n \"updated_at\": \"2024-03-05 12:52:50\",\n \"deleted_at\": null,\n \"course_id\": null,\n \"asset_id\": 7,\n \"asset\": {\n \"id\": 7,\n \"name\": \"Membership 1\",\n \"asset_category_id\": 2,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"100.00\",\n \"purchase_date\": \"2023-12-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"description\": null,\n \"created_at\": \"2024-02-16 09:41:18\",\n \"updated_at\": \"2024-02-16 09:41:18\",\n \"deleted_at\": null,\n \"asset_type_id\": 2\n },\n \"employee\": {\n \"id\": 44,\n \"user_id\": 46,\n \"ssn\": null,\n \"birth_date\": null,\n \"hire_date\": \"2024-03-05\",\n \"hire_date_utc\": \"2024-03-04 22:00:00\",\n \"personal_email\": null,\n \"marital_status\": null,\n \"nationality\": null,\n \"work_phone\": null,\n \"phone\": null,\n \"country\": null,\n \"address\": null,\n \"postal_code\": null,\n \"city\": null,\n \"reports_to_employee_id\": 15,\n \"linked_in_url\": null,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/public-assets/people/default-avatar.png?Expires=1709729570&Signature=NtIuJ-KndrZe3JmILtILyrt6A7NfP1ElDmSY0R6GVxVLMkBRKJtPPTp6gt0~9z1x2UBOY0zi9Nx48MosjHagwwkJJga9RD~FBki3UaqxicEDMNG8aeJHIVV~TdFmKjQ9tvrMFnKUEm7VcDgadfr8~g5dkWvQ5a-jHChAcaI0Qx5PdLFYmujN6jlc0ANQlaxqfbLoTbyu9GPJsIkfr0zJZHtVKdhU2UPKpMehWmcpWPO1t2sffYdfxCP8D~wApufGhjSAfR4n6apop5gyKSHoJv9RncYLFCroBQ6rs5kmGZsG~j80h-kDYtV3wxOG49U~NqgmobMotFpmVddfjvibyw__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"citizenship\": null,\n \"termination_date\": null,\n \"termination_date_utc\": null,\n \"is_existing\": 0,\n \"created_at\": \"2024-03-05 09:41:18\",\n \"updated_at\": \"2024-03-05 09:41:18\",\n \"deleted_at\": null,\n \"gender\": null,\n \"job_title_id\": null,\n \"division_id\": null,\n \"department_id\": null,\n \"location_id\": 36,\n \"employment_status_id\": 1,\n \"employee_number\": null,\n \"passport_number\": null,\n \"passport_issued_date\": null,\n \"passport_expiry_date\": null,\n \"passport_issuing_country\": null,\n \"visa_type\": null,\n \"visa_number\": null,\n \"visa_expiry_date\": null,\n \"driver_license_number\": null,\n \"driver_license_issued_date\": null,\n \"driver_license_expiry_date\": null,\n \"driver_license_issuing_country\": null,\n \"sec_address\": null,\n \"sec_city\": null,\n \"sec_postal_code\": null,\n \"sec_country\": null,\n \"twitter_url\": null,\n \"facebook_url\": null,\n \"instagram_url\": null,\n \"pinterest_url\": null,\n \"github_url\": null,\n \"behance_url\": null,\n \"skype_name\": null,\n \"shirt_size\": null,\n \"t_shirt_size\": null,\n \"allergies\": null\n },\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n }\n }\n}"},{"id":"c5c516a2-099f-42c4-8697-d086fb18d7b6","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/task-assignments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","task-assignments",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"d5536723-f6f3-41a2-8d23-6529d4dfd547","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/task-assignments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","task-assignments",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"51395a57-9b3b-42ec-9044-e826f32f3fc1"},{"name":"Get employee's time off budgets","id":"91964ca0-2bd4-46f1-ae78-8c7c6a838321","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets","description":"

API Endpoint to get the Time Off budgets of an employee.

\n

This endpoint provides comprehensive information into the time-off budgets (the allocated amount of time off) allocated for the specified employee yearly. This includes historical data from the employee's start year to the year following the current calendar year.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","time-off-budgets"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"46fa6591-ad6b-438a-ace2-b37500482f35","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"30fecdf9-9cec-4081-84b9-b9b15b76a9a7","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-budgets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 10,\n \"employee_id\": 1,\n \"budget\": \"15.000\",\n \"year\": \"2023\",\n \"timeoff_type_name\": \"Vacation\",\n \"timeoff_type_slug\": \"vacation\",\n \"used_budget\": \"0.000\",\n \"original_budget\": \"15.000\",\n \"paid\": true,\n \"timeoff_type_id\": 4,\n \"created_at\": \"2023-11-15 13:56:10\",\n \"updated_at\": \"2023-12-04 10:19:38\",\n \"deleted_at\": null\n }\n ]\n}"},{"id":"17765e7c-1137-4d27-9e63-b072c51e070d","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-budgets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"91964ca0-2bd4-46f1-ae78-8c7c6a838321"},{"name":"Update a time off budget","id":"2570599b-377e-4cf5-a870-44984d1fb38a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"original_budget\": \"\" // (Required) Employee's original time off budget (in days) for a time off type. Min value is 0 and max is 365. Allows 3 decimal places.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets/:objectId","description":"

API Endpoint to update the Time Off budget of an employee.

\n

This endpoint facilitates the updating of the time-off budget for the specified employee. To use this endpoint , the Employee id and the Time off budget id must be specified. The budget value must fall within the range of greater than 1 day and less than 365 days.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
original_budgetnumbertrueEmployee's original time off budget (in days) for a time off type. Min value is 0 and max is 365. Allows 3 decimal places.e.g. 12.5
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","time-off-budgets",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"e852fe75-04bf-4a72-a3b4-bbf9369d039c","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"d1459567-d0a7-4851-aaff-75bba0b8e8d9","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"05cc92a4-5b06-4ac1-bfb1-3dae0ba20f9f","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"original_budget\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-budgets",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 10,\n \"employee_id\": 1,\n \"budget\": \"15.000\",\n \"year\": \"2023\",\n \"used_budget\": \"0.000\",\n \"original_budget\": \"15.000\",\n \"timeoff_type_id\": 4,\n \"created_at\": \"2023-11-15 13:56:10\",\n \"updated_at\": \"2023-12-04 10:19:38\",\n \"deleted_at\": null,\n \"timeoff_type\": {\n \"id\": 4,\n \"name\": \"Vacation\",\n \"slug\": \"vacation\"\n }\n }\n}"},{"id":"067e88d0-9d45-4ebf-ac4a-1eb0f6ed2de4","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"original_budget\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-budgets",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"a767220f-5c6a-4936-857d-32c5f248be46","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"original_budget\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-budgets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-budgets",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"2570599b-377e-4cf5-a870-44984d1fb38a"},{"name":"Get employee's time off requests","id":"a084bf09-87f6-4c1f-86d0-2d42f5944f35","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests?limit=&offset=&sort=","description":"

API Endpoint to get the Time Off requests of an employee.

\n

This endpoint retrieves comprehensive information regarding time-off requests of the specified employee. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, you can sort the retrieved data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","time-off-requests"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's sort. Enum ['id', 'timeoff_type_name', 'created_at']

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[{"id":"be38f5cf-808e-4890-b42a-5ca4deba47d2","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"fd49f832-42f9-4989-aa7e-acf9d47eaf02","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests?limit=&offset=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\\\"\": \"true,\",\n \"data\\\"\": {\n \"total\\\"\": 5,\n \"rows\\\"\": [\n {\n \"id\": 20,\n \"approved\": true,\n \"note\": null,\n \"budget\": \"2.000\",\n \"is_canceled\": true,\n \"start_date\": \"2024-01-08\",\n \"end_date\": \"2024-01-10\",\n \"employee_id\": 1,\n \"created_at\": \"2024-01-10 11:22:09\",\n \"updated_at\": \"2024-01-10 12:10:03\",\n \"deleted_at\": null,\n \"timeoff_type_id\": 4,\n \"timeoff_type_name\": \"Vacation\",\n \"timeoff_type_slug\": \"vacation\",\n \"allow_cancel\": false\n },\n {\n \"id\": 19,\n \"approved\": true,\n \"note\": null,\n \"budget\": \"5.000\",\n \"is_canceled\": true,\n \"start_date\": \"2023-12-11\",\n \"end_date\": \"2023-12-15\",\n \"employee_id\": 1,\n \"created_at\": \"2023-12-04 10:19:22\",\n \"updated_at\": \"2023-12-04 10:19:38\",\n \"deleted_at\": null,\n \"timeoff_type_id\": 4,\n \"timeoff_type_name\": \"Vacation\",\n \"timeoff_type_slug\": \"vacation\",\n \"allow_cancel\": false\n }\n ]\n }\n}"},{"id":"ec538092-bcd4-4af4-b097-2ceaf936cd97","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests?limit=&offset=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"a084bf09-87f6-4c1f-86d0-2d42f5944f35"},{"name":"Create a time off request","id":"746cb9d8-2bab-4683-be04-f882d83d545c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\", // (Required) The start date must be formatted as 'YYYY-MM-DD'. For a future-hire employee, time off requests cannot have a start date before their hire date. Similarly, for a future terminated employee, the start date of a time off request cannot occur after their termination date. The date must fall within one year from the current date.\n \"end_date\": \"\", // (Required) The end date must be formatted as 'YYYY-MM-DD' and must be a date greater or equal than the start_date. The date must fall within one year from the current date.\n \"timeoff_type_id\": \"\", // (Required) The id of the time-off type.\n \"preapproved\": \"\", // If this is 'true' then the time-off request will be accepted automatically else the manager has to approve/reject it.\n \"amount_options\": { // Object with keys as dates in YYYY-MM-DD format and corresponding values representing time off (float). Time off values range are from '1' (full working day) to fractional values (e.g., 0.5 for half a working day, 0.25 for a quarter of the working day, etc.). Dates corresponding to holidays or non-working days are set to '0'. This object must include all dates between the specified start_date and end_date.\n \"\": \"\",\n \"\": \"\"\n },\n \"note\": \"\" // Maximum character limit: 255 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests","description":"

API Endpoint to book a time off request.

\n

This endpoint facilitates the booking of a time-off request for the specified employee. A time off request is an entity that describes the decision making process for approving time off.
It can be used for various reasons such as vacation, personal matters, bereavement or illness.

\n

The request body includes the start and end dates for the time-off request, the type of time-off requested, the preapproved attribute indicating whether the request will be automatically approved or requires manager approval, the amount option providing a detailed analysis of each day's duration (e.g., full-day as 1, half-day as 0.5, etc), and optional notes accompanying the request.

\n
    \n
  • For future-hire employees, the time-off request cannot have a start date before their hire date.
    • \n
  • For terminated employees, the time-off request must come before the termination date.
    • \n
\n

Note: The start_date and end_date must fall within one year from the current date.

\n
\n

When the \"book time off\" request is successfully submitted and the preapproval status is set to false, an email is automatically dispatched to the employee's manager, requesting approval or rejection of the time off request. If the manager is currently off work and thus unable to respond, an email notification is sent to the employee, informing them that their manager is presently unavailable to address the request.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
start_datedatetrueThe start date must be formatted as 'YYYY-MM-DD'. For a future-hire employee, time off requests cannot have a start date before their hire date. Similarly, for a terminated employee, the start date of a time off request cannot occur after their termination date. The date must fall within one year from the current date.e.g 2024-01-10
end_datedatetrueThe end date must be formatted as 'YYYY-MM-DD' and must be a date greater than the start_date. The date must fall within one year from the current date.e.g 2024-01-14
timeoff_type_idintegertrueThe id of the time-off type.-
preapprovedbooleanfalseIf this is 'true' then the time-off request will be accepted automatically else the manager has to approve/reject it.-
amount_optionsobjectfalseObject with keys as dates in YYYY-MM-DD format and corresponding values representing time off (float). Time off values range are from '1' (full working day) to fractional values (e.g., 0.5 for half a working day, 0.25 for a quarter of the working day, etc.). The minimum fractional value is '0.001' working day. Dates corresponding to holidays or non-working days are set to '0'. This object must include all dates between the specified start_date and end_date.e.g. {\"2024-01-10\":1,\"2024-01-11\":1,\"2024-01-12\":0.5,\"2024-01-13\":0,\"2024-01-14\":0}\"
notestringfalseMaximum character limit: 255 characters.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","time-off-requests"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"714bc2d4-a5ea-4d46-a673-4ceee551003e","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"2d39afc0-7e01-4faf-8635-a7a4b22fa85c","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"timeoff_type_id\": \"\",\n \"preapproved\": \"\",\n \"amount_aptions\": \"{\\\"2024-03-04\\\":1,\\\"2024-03-05\\\":1,\\\"2024-03-06\\\":1,\\\"2024-03-07\\\":1,\\\"2024-03-08\\\":1}\",\n \"note\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 24,\n \"employee_id\": 1,\n \"assignee_id\": 43,\n \"timeoff_type_id\": 1,\n \"start_date\": \"2024-02-10\",\n \"end_date\": \"2024-02-15\",\n \"answered\": false,\n \"approved\": null,\n \"budget\": \"4.000\",\n \"note\": null,\n \"replier_id\": null,\n \"is_canceled\": false,\n \"created_at\": \"2024-03-06 09:08:05\",\n \"updated_at\": \"2024-03-06 09:08:05\",\n \"deleted_at\": null,\n \"time_off_type\": {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\"\n },\n \"allow_cancel\": true\n }\n}"},{"id":"7adb2b97-8b3a-45d7-b063-b47fa23f7b56","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"timeoff_type_id\": \"\",\n \"preapproved\": \"\",\n \"amount_aptions\": \"{\\\"2024-03-04\\\":1,\\\"2024-03-05\\\":1,\\\"2024-03-06\\\":1,\\\"2024-03-07\\\":1,\\\"2024-03-08\\\":1}\",\n \"note\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"f6975d53-ea3c-461a-9a1d-000d2a24029f","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"timeoff_type_id\": \"\",\n \"preapproved\": \"\",\n \"amount_aptions\": \"{\\\"2024-03-04\\\":1,\\\"2024-03-05\\\":1,\\\"2024-03-06\\\":1,\\\"2024-03-07\\\":1,\\\"2024-03-08\\\":1}\",\n \"note\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"746cb9d8-2bab-4683-be04-f882d83d545c"},{"name":"Approve or reject time off request","id":"bdd87edc-5280-4bbd-8dff-9ed339d3e09b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accept\": \"\" // Required field. Approve 'true' or Reject 'false' the specified time off request.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests/:objectId/reply","description":"

API Endpoint to approve or reject a specified time off request for an employee.

\n

This endpoint enables the approval or rejection of time-off requests specifically for employees under your supervision.

\n
\n

When a decision is made and submitted successfully regarding the approval or rejection of this request, an email is automatically sent to the employee. This email notifies the employee about the outcome, ensuring they are promptly informed whether their request has been approved or rejected.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
acceptbooleantrueApprove 'true' or Reject 'false' the specified time off request. If the time off request has been answered or it has been cancelled then you cannot appove or reject it.e. g. true
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","time-off-requests",":objectId","reply"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"0126ec63-6620-4de5-a330-d3b68bdacf52","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"74f060eb-ff22-4a9d-aac0-80f26574ce9b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"a5060cc1-2453-43dd-ae31-c1c190c41042","name":"Simple boolean response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accept\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests/:objectId/reply","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests",":objectId","reply"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"17818f13-cdae-4ba7-92b8-7fe7acb72fa7","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accept\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests/:objectId/reply","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests",":objectId","reply"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"68dd9fdd-0d6f-4f83-bb2f-1165597008a3","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accept\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/time-off-requests/:objectId/reply","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","time-off-requests",":objectId","reply"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"bdd87edc-5280-4bbd-8dff-9ed339d3e09b"},{"name":"Change role to 'Employee'","id":"88ab323a-4bfb-4e61-bb94-87a1cc5d6d7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/make-employee","description":"

API Endpoint to change the user role of an employee to “Employee”.

\n

This endpoint facilitates the change of role for the specified employee to 'Employee'. However, if the employee's current role is already 'Employee', attempting this change will result in a 409 (Conflict) status error message.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","make-employee"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"4c3300fd-b82c-4db1-a25a-58d3f44a1865","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"6b8e4784-1f54-4d7c-a839-b8b5a3456f2d","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/make-employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","make-employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"employee_id\": 10\n }\n}"},{"id":"c5e40321-a7d3-44c5-b269-818d464b4d19","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/make-employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","make-employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"419b9387-ec41-4475-a0fc-086e31d9874d","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/make-employee","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","make-employee"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"88ab323a-4bfb-4e61-bb94-87a1cc5d6d7c"},{"name":"Change role to 'HR-Manager'","id":"d38df0d7-4810-4659-8fa2-f804658cca0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/make-hr-manager","description":"

API Endpoint to change the user role of an employee to “HR-Manager”.

\n

This endpoint facilitates the change of role for the specified employee to 'HR-Manager'. However, if the employee's current role is already 'HR-Manager', attempting this change will result in a 409 (Conflict) status error message.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","make-hr-manager"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"05779e73-4dc6-4ea7-bd5d-221e451421e7","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"92cfc69b-5a1a-44b1-bc1c-f0aedaf27049","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/make-hr-manager","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","make-hr-manager"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"employee_id\": 10\n }\n}"},{"id":"e7a34f31-4365-439e-a273-fc0d583fd428","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/make-hr-manager","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","make-hr-manager"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"4879f345-8464-4c11-8247-ce5bdc64ffa4","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/make-hr-manager","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","make-hr-manager"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"d38df0d7-4810-4659-8fa2-f804658cca0f"},{"name":"Show employee manager","id":"bca52364-bffa-4b41-879b-e13382498b60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","description":"

API Endpoint to retrieve a specified Manager record of an employee.

\n

This endpoint retrieves the specified manager record for the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","managers",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"f4894179-9ff5-4fca-a67e-3bc8e18339b9","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"beb2ccef-8292-42e7-a0b5-8a4d4da9a91d","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"9131ff8a-5607-4c2e-96d6-7a26ad62f103","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 18,\n \"employee_id\": 15,\n \"reports_to_employee_id\": 1,\n \"effective_date\": \"2012-01-02\",\n \"end_date\": null,\n \"from_id\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:45:25\",\n \"deleted_at\": null,\n \"manager\": {\n \"id\": 1,\n \"user_id\": 1,\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n }\n}"},{"id":"9cc39afe-0281-4896-bae7-0f6fb5f5dcbf","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"bca52364-bffa-4b41-879b-e13382498b60"},{"name":"Update a manager record","id":"88127a55-c87a-4c8a-a244-37fbf1bcea75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\", // The effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'.\n \"reports_to_employee_id\": \"\" // The employee Id that is goint to be the manager of the specified employee.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","description":"

API Endpoint to update a specified Manager record of an employee.

\n

This endpoint updates a manager record for the specified employee. The request body should include these variables: the effective date of the record, formatted as 'YYYY-MM-DD', and the manager's employee ID.

\n

You can only modify the current(active) manager record.

\n

When we are updating a new manager record, we should avoid creating loops or circles in the organization hierarchy.

\n

It's essential to note that an employee must have at least one manager record with an effective date matching their hire date. While creating a new manager record we have to know:

\n
    \n
  • The effective date must be after or equal of employee's hire date.
    • \n
  • If a termination date is specified for the employee, then the effective date must not exceed the termination date.
    • \n
  • If the specified employee is a future hire, then you cannot assign them any manager until after their hire date.
    • \n
  • The person that is going to be the manager of the specified employee must be an active employee.
    • \n
  • While updating the current active manager record, Task Assignments and Performance reviews that concern the current manager of the specified employee will be reassigned to the new manager.
    • \n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
effective_datedatetrueThe effective date that this takes place. The effective date must be formatted as 'YYYY-MM-DD'.
The date must before or equal of the current date and after or equal employee's hire date.		e.g. 2024-02-01
reports_to_employee_idintegertrueThe employee ID (Active Employee) that is going to be the manager of the specified employee.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","managers",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"22784da7-fa4c-44cf-8fb6-6ca66e19bdf2","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"ba18b6d4-8a7c-4809-9eb7-1b8ea6cd3ca2","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"ee9bb938-b93d-47bc-85e1-02d7fc938c8a","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"reports_to_employee_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 18,\n \"employee_id\": 15,\n \"reports_to_employee_id\": 1,\n \"effective_date\": \"2012-01-02\",\n \"end_date\": null,\n \"from_id\": null,\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2023-11-15 14:45:25\",\n \"deleted_at\": null,\n \"manager\": {\n \"id\": 1,\n \"user_id\": 1,\n \"user\": {\n \"id\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\"\n }\n }\n }\n}"},{"id":"327d96cd-adcf-47e6-9b12-d24690428fd1","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"reports_to_employee_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"857a7203-53d8-4903-b317-496b583a71d2","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"effective_date\": \"\",\n \"reports_to_employee_id\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/managers/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","managers",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"88127a55-c87a-4c8a-a244-37fbf1bcea75"},{"name":"Show employee settings","id":"ff4a0a7c-d1f5-4b0d-8130-85f3f2d68a6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/settings","description":"

API Endpoint to retrieve the timezone and language preference of an employee.

\n

This endpoint provides access to the custom settings configured by employees. These settings include preferred language for the system interface and timezone preferences.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","settings"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"5529872a-7610-40fa-897b-327e0cb9a309","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"fc238347-5c6b-4fd6-9a21-ca97f2f672c2","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/settings","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","settings"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"timezone\": \"Europe/Athens\",\n \"language_locale\": \"en\",\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2024-03-01 11:12:24\",\n \"deleted_at\": null\n }\n}"},{"id":"81a7f79a-6750-4de1-bd17-3ed8ba606aad","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/settings","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","settings"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"ff4a0a7c-d1f5-4b0d-8130-85f3f2d68a6c"},{"name":"Update employee settings","id":"cd602d38-f5b7-4126-9dd4-296fe1d36587","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timezone\": \"\", // (Required) This must be a valid timezone from the provided 'timezones' of the system.\n \"language\": \"\" // (Required) This must be a valid language code from the provided 'languages' of the system.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/settings","description":"

API Endpoint to update the timezone and language of an employee.

\n

This endpoint allows for the update of employee preferences, including preferred language for the system interface and desired timezone settings.

\n

Note: Both language and timezone must be valid values provided by the 'timezones' & 'languages' of the system.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
timezonestringtrueThis must be a valid timezone from the provided 'timezones' of the system.e.g. Europe/Athens
languagestringtrueThis must be a valid language code from the provided 'languages' of the system.e.g. en (for English)
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","settings"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"299ac064-24d3-4371-90aa-5a3b51638005","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"313c31b4-f0ba-46fb-ad70-f27232bc29a4","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timezone\": \"\",\n \"language\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/settings","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","settings"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"timezone\": \"Europe/Athens\",\n \"language_locale\": \"en\",\n \"created_at\": \"2023-11-15 14:45:25\",\n \"updated_at\": \"2024-03-01 11:12:24\",\n \"deleted_at\": null\n }\n}"},{"id":"0ef28a8b-6176-4e00-a4cf-c0eae11f4db5","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timezone\": \"\",\n \"language\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/settings","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","settings"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"366fc422-14ed-48d1-945c-b97b0a253e5c","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"timezone\": \"\",\n \"language\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/settings","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","settings"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"cd602d38-f5b7-4126-9dd4-296fe1d36587"},{"name":"Get employee assets","id":"02e7bc80-2b16-4278-be9e-325031754db8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/assets?limit=&offset=&order=&sort=","description":"

API Endpoint to retrieve the assets that are assigned to an employee.

\n

This endpoint retrieves comprehensive information regarding the assets (Inventory and Membership) assigned to the specified employee. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, users can customize the order and sorting of the retrieved data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","assets"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum ['assing_date', 'name', 'category', 'type', 'serial_number']

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[{"id":"4f53d6a7-99fe-4f76-8339-f6192a6188de","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"9b3d87f8-56b9-4e4c-a940-48e446e2f50e","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/assets?limit=&offset=&order=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","assets"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 11,\n \"name\": \"membership-name\",\n \"asset_category_id\": 6,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"asset_type_id\": 2,\n \"description\": \"This is a description...\",\n \"created_at\": \"2024-02-14 09:28:07\",\n \"updated_at\": \"2024-02-14 09:28:55\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n },\n \"asset_status\": {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n ]\n }\n}"},{"id":"ca3f3e54-5371-40df-970c-81f2cc688230","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/assets?limit=&offset=&order=&sort=","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","assets"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""}],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"02e7bc80-2b16-4278-be9e-325031754db8"},{"name":"Get employee available assets","id":"50c4f9e6-398e-4476-93c5-539391a77282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/available-assets","description":"

API Endpoint to retrieve the assets that are available to be assigned to an employee.

\n

This endpoint provides a comprehensive list of available assets, accessible to the specified employee, within the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","available-assets"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a9f37578-6305-4c90-9edf-aea4e0e27c38","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"6b11a08b-4078-4665-9501-240b21c662ab","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/available-assets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","available-assets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 19,\n \"name\": \"inventory-name\",\n \"asset_category_id\": 1,\n \"asset_type_id\": 1,\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n },\n \"asset_category\": {\n \"id\": 1,\n \"name\": \"category-name\",\n \"asset_type_id\": 1\n }\n }\n ]\n}"},{"id":"e633283a-a53b-4414-8d6a-1007f4a4f488","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/available-assets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","available-assets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"2439d09d-eb93-4faa-a765-636763208193","name":"Internal server error (500)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/available-assets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","available-assets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The Error message...\",\n \"code\": \"HY000\",\n \"hr_code\": 100\n }\n}"}],"_postman_id":"50c4f9e6-398e-4476-93c5-539391a77282"},{"name":"Assign assets to a specified employee","id":"7c2cc3be-b2f0-44cb-8eb5-62d94b07d30a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"assets\" : [\"\"] // (Required) Array of Asset Ids. (Both membership and Inventory Assets). The assets status on these assets must be 'avaialable'.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/assign-assets","description":"

API Endpoint to assign assets to a specified employee.

\n

This endpoint facilitates the assignment of assets (both Inventory and Membership type) to a specified employee. The request body should include an array of assets to be assigned. It's important to ensure that the selected assets are available for assignment to the specified employee.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
assetsarraytrueArray of Asset Ids. (Both membership and Inventory Assets). The asset status on these assets must be 'avaialable'.e.g. [1,2,3,4]
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","assign-assets"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a58edd94-aa1b-4604-90f9-6ab4bd4118b5","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"39ac91f6-eada-49c7-944e-76394b35b795","name":"Simple boolean response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/assign-assets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","assign-assets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"215e048c-f9bc-401e-b123-18074e0edca6","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/assign-assets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","assign-assets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"ca259a16-86fa-4c72-a08b-74ad821fd48f","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/assign-assets","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","assign-assets"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"7c2cc3be-b2f0-44cb-8eb5-62d94b07d30a"},{"name":"Upload employee's avatar","id":"193a872c-fe69-4a0e-96d0-7250725d393a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"avatar","description":"

(Required) Image of employee's avatar. The current image must not surpass 10MB. Valid formats (jpng, jpg, jpeg, svg, webp)

\n","type":"file","value":null}]},"url":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","description":"

API Endpoint to upload the avatar of the specified employee.

\n

This endpoint enables the update of the avatar (photo) for the specified employee. The uploaded image should be in one of the valid formats: png, jpg, jpeg, svg, or webp, and must not exceed 10MB in size.

\n
\n

Filenames within the system must not start with any illegal character or symbol (e.g. @ (at sign), $ (dollar sign), % (percent), & (ampersand)) and should maintain a reasonable length, ensuring they do not exceed 250 characters.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
avatarfiletrueImage of employee's avatar. The current image must not surpass 10MB. Valid formats (
png, jpg, jpeg, svg, webp
)		-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","avatar"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"58c994fe-454b-4cad-89f4-d9d3820ce3cc","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"613ea81c-64aa-4b33-a806-1a80cf39fa9f","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accept\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","avatar"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"employee\": {\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1_1710511790.jpeg...\"\n }\n }\n}"},{"id":"c4b62648-8847-435a-8b87-2867570d41b1","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","avatar"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"479dde0b-3528-4019-a391-1224349991f6","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","avatar"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"193a872c-fe69-4a0e-96d0-7250725d393a"},{"name":"Delete employee's avatar","id":"a2afca85-3f1b-459e-b0c1-d9b160005c08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"formdata","formdata":[]},"url":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","description":"

API Endpoint to delete employee's avatar.

\n

This endpoint deletes the avatar (photo) of the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","avatar"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"67231c90-2401-4dce-9306-46c7a32229d2","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"217026f9-5288-45dc-8a57-1b012fc52a4e","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"accept\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","avatar"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"employee\": {\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1_1710511790.jpeg...\"\n }\n }\n}"},{"id":"dc18a517-a446-45b9-8299-e0d8431411bc","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/avatar","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","avatar"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"a2afca85-3f1b-459e-b0c1-d9b160005c08"}],"id":"1e4f3351-5e4a-41b8-a5ef-9dbe69f89e8a","_postman_id":"1e4f3351-5e4a-41b8-a5ef-9dbe69f89e8a","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Employee (Education Records)","item":[{"name":"Get Employee's Education records","id":"72a530b3-ea2d-4bd4-86cc-04eea7ac394c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","description":"

API endpoint to get the education information of an employee.

\n\n

This API endpoint get all the education items of the employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","education-records"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"91dc376b-ef70-4976-a1bd-7e87a2f91c76","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"4f0f25a6-a22d-40b1-8066-3a8cce911a31","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"education-records\": [\n {\n \"id\": 1,\n \"employee_id\": 1,\n \"education_level_id\": 4,\n \"grad_date\": \"2024-02-08\",\n \"department\": \"a-department\",\n \"institution\": \"an-institution\",\n \"created_at\": \"2024-02-09 12:43:36\",\n \"updated_at\": \"2024-02-09 12:43:36\",\n \"deleted_at\": null,\n \"education_level\": {\n \"id\": 4,\n \"name\": \"BSc\"\n }\n },\n {\n \"id\": 2,\n \"employee_id\": 1,\n \"education_level_id\": 2,\n \"grad_date\": \"2023-12-05\",\n \"department\": \"a-department\",\n \"institution\": \"an-institution\",\n \"created_at\": \"2024-02-09 13:58:46\",\n \"updated_at\": \"2024-02-09 13:58:46\",\n \"deleted_at\": null,\n \"education_level\": {\n \"id\": 2,\n \"name\": \"Other\"\n }\n }\n ]\n}"},{"id":"1fe988a7-0568-4468-ae43-9454036f1638","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"72a530b3-ea2d-4bd4-86cc-04eea7ac394c"},{"name":"Create an education record","id":"f313dc84-9ad0-4d12-b72e-3756c401960f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\", // Required field. Unique identifier of education levels.This must be a valid education level from the provided 'education levels' of the system.\n \"grad_date\": \"\", // Required field. The graduation date must be formatted as 'YYYY-MM-DD'.\n \"department\": \"\", // Required field. Maximum character limit:191 characters.\n \"institution\": \"\" // Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","description":"

API endpoint to create an education record for an employee.

\n\n

This API endpoint enables the creation of education record for the specified employee. You should provide the employee's gradutation date, the department ,the institution and the education level id.

\n

Note: You can locate the desired education level ID by accessing the 'education levels' endpoint.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
education_level_idintegertrueUnique identifier of education levels.e.g 1
grad_datedatetrueThe graduation date must be formatted as 'YYYY-MM-DD'.e.g 2024-03-01
departmentstringtrueA division of a large organization such as university. Maximum character limit:191 characters.e.g Computer Science
institutionstringtrueAn organization founded for a education purpose. Maximum character limit:191 characters.e.g University of Crete
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","education-records"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"04f03bc6-009f-4342-906f-c7d5862825b5","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"a49defd0-d961-43d6-a0fc-601df03f5dc4","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\",\n \"grad_date\": \"\",\n \"department\": \"\",\n \"institution\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"education_level_id\": 3,\n \"grad_date\": \"2024-02-01\",\n \"department\": \"a-department\",\n \"institution\": \"an-institution\",\n \"employee_id\": 1,\n \"updated_at\": \"2024-02-09 14:02:56\",\n \"created_at\": \"2024-02-09 14:02:56\",\n \"id\": 4,\n \"education_level\": {\n \"id\": 3,\n \"name\": \"MSc\"\n }\n }\n}"},{"id":"3fa6c0a0-2b50-423b-b2b8-45ece4e74e32","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\",\n \"grad_date\": \"\",\n \"department\": \"\",\n \"institution\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"69df672b-5bea-4cd0-b2df-2c2d84864eea","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\",\n \"grad_date\": \"\",\n \"department\": \"\",\n \"institution\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"f313dc84-9ad0-4d12-b72e-3756c401960f"},{"name":"Update an education record","id":"ef62f3b7-7b46-4730-809a-cda1f42ce1c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\", // Required field. Unique identifier of education levels.This must be a valid education level from the provided 'education levels' of the system.\n \"grad_date\": \"\", // Required field. The graduation date must be formatted as 'YYYY-MM-DD'.\n \"department\": \"\", // Required field. Maximum character limit:191 characters.\n \"institution\": \"\" // Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","description":"

API endpoint to update the specified education record of an employee.

\n\n

This API endpoint updates an education record for the specified employee. You should provide the employee's gradutation date, the department ,the institution and the education level id.

\n

Note: You can locate the desired education level ID by accessing the 'education levels' endpoint.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
education_level_idintegertrueUnique identifier of education levels.e.g 1
grad_datedatetrueThe graduation date must be formatted as 'YYYY-MM-DD'.e.g 2024-03-01
departmentstringtrueA division of a large organization such as university. Maximum character limit:191 characters.e.g Computer Science
institutionstringtrueAn organization founded for a education purpose. Maximum character limit:191 characters.e.g University of Crete
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","education-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"59d2a7bf-88e5-4738-8a36-b12cd6a5933d","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"18a9618a-4ab3-41a0-b826-8fd963a4d69b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"967e7b7e-4757-4808-9eb1-541be6df5fec","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\",\n \"grad_date\": \"\",\n \"department\": \"\",\n \"institution\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"education_level_id\": 3,\n \"grad_date\": \"2024-02-01\",\n \"department\": \"a-department\",\n \"institution\": \"an-institution\",\n \"employee_id\": 1,\n \"updated_at\": \"2024-02-09 14:02:56\",\n \"created_at\": \"2024-02-09 14:02:56\",\n \"id\": 4,\n \"education_level\": {\n \"id\": 3,\n \"name\": \"MSc\"\n }\n }\n}"},{"id":"0e5024bf-0880-475e-9cbb-dcd21aaf9171","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\",\n \"grad_date\": \"\",\n \"department\": \"\",\n \"institution\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"ed4181b2-bb2c-477b-9496-0a283e6c0c18","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"education_level_id\": \"\",\n \"grad_date\": \"\",\n \"department\": \"\",\n \"institution\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"ef62f3b7-7b46-4730-809a-cda1f42ce1c4"},{"name":"Delete an education record","id":"082cc82e-5eee-4112-9531-890b2012fbcc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","description":"

API endpoint to delete the specified education record of an employee.

\n\n

This endpoint deletes the specified education record for the specified employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["employees",":employee","education-records",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b8108c4b-a509-48f0-af9d-4cf486b32bcf","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"},{"id":"a00d18ab-4d04-4c29-ac4a-ee9ba109fb86","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"5258dcd5-8d85-4b5d-919b-c4925074bb94","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"88c98c59-f796-4aab-998a-bb52dd034325","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/employees/:employee/education-records/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["employees",":employee","education-records",":objectId"],"variable":[{"key":"employee","value":"","description":"(Required) The id of the employee"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"082cc82e-5eee-4112-9531-890b2012fbcc"}],"id":"8edd6c17-cde5-4867-a769-61d22b3f8992","_postman_id":"8edd6c17-cde5-4867-a769-61d22b3f8992","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Directory","item":[{"name":"Get a directory's filters","id":"b25229d2-06f8-45f9-8b23-f14b725b7b77","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/directory/filters","description":"

API Endpoint to retrieves the available filters for directory.

\n

This endpoint allows you to fetch a list of valid filters for the directory. Utilize the 'id' field from the returned objects to filter employees in the 'directory' endpoint.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["directory","filters"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"4590b2e8-2681-4873-8dca-fe4c6ed1ee99","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/directory/filters"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"departments\": [\n {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 7,\n \"name\": \"Research & Development\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 8,\n \"name\": \"Marketing & Sales\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 9,\n \"name\": \"Human Resources\",\n \"object_type\": \"department\"\n }\n ],\n \"divisions\": [\n {\n \"id\": 12,\n \"name\": \"North America\",\n \"object_type\": \"division\"\n },\n {\n \"id\": 13,\n \"name\": \"Europe\",\n \"object_type\": \"division\"\n }\n ],\n \"locations\": [\n {\n \"id\": 33,\n \"name\": \"New York\",\n \"object_type\": \"location\"\n },\n {\n \"id\": 34,\n \"name\": \"California\",\n \"object_type\": \"location\"\n },\n {\n \"id\": 35,\n \"name\": \"London\",\n \"object_type\": \"location\"\n },\n {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\"\n }\n ],\n \"emp_state\": [\n {\n \"id\": 1,\n \"name\": \"Full-Time\",\n \"object_type\": \"employment_status\"\n },\n {\n \"id\": 2,\n \"name\": \"Part-Time\",\n \"object_type\": \"employment_status\"\n }\n ],\n \"time_off_types\": [\n {\n \"id\": 4,\n \"name\": \"Vacation\",\n \"slug\": \"vacation\"\n },\n {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\"\n }\n ]\n }\n}"}],"_postman_id":"b25229d2-06f8-45f9-8b23-f14b725b7b77"},{"name":"Get directory's info","id":"7d5408ba-aa8b-4187-bd0e-0e347cdea5d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/directory?limit=&offset=&filter=","description":"

API Endpoint to retrieve all the employees with some information for each of them.

\n

This endpoint retrieves comprehensive information regarding the system's employee directory. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, you have the option to utilize filters to precisely retrieve the data you want. You can find suitable IDs for the current filters by accessing the 'directory filters' endpoint.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["directory"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Filters for the directory arrays with their Ids (integer), ('location' => [],'department' => [],'division' => [],'time_off' => [],'time_off_type' => [],'emp_state' => [],'time_off_status' => []). Example: location=36;emp_state=1,2,3,5;

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"d3677084-80a8-4dad-bbc2-3d7006649cae","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/directory?limit=&offset=&filter=location=36;emp_state=1,2,3,5;","host":["https://pubapi.talenthr.io/v1"],"path":["directory"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"filter","value":"location=36;emp_state=1,2,3,5;"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 19,\n \"user_id\": 19,\n \"reports_to_employee_id\": 1,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/public-assets/people/default-avatar.png...\",\n \"u_id\": 19,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"division_id\": 13,\n \"division\": \"Europe\",\n \"employment_status_id\": 1,\n \"employment_status_name\": \"Full-Time\",\n \"department_id\": 6,\n \"department\": \"Administration & Operations\",\n \"job_title_id\": 26,\n \"job_title\": \"Business Analyst\",\n \"location_id\": 36,\n \"location\": \"Athens\",\n \"termination_date\": null,\n \"hire_date\": \"2023-11-28\",\n \"linked_in_url\": null,\n \"work_phone\": null,\n \"user_role\": {\n \"id\": 3,\n \"slug\": \"employee\",\n \"name\": \"Employee\"\n }\n }\n ]\n }\n}"}],"_postman_id":"7d5408ba-aa8b-4187-bd0e-0e347cdea5d0"},{"name":"Get organization chart's info","id":"2670259b-e767-41ca-97f8-80abe78300a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/organization-chart","description":"

API Endpoint to retrieve all the current employees with their managers.

\n

This endpoint retrieves comprehensive information regarding the system's organization chart.

\n

The organization chart shows the company's internal structure by detailing the roles, and relationships between the employees of the company.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["organization-chart"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"d2911d6c-4dda-461d-bb19-36da251b1e64","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/organization-chart"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 1,\n \"reports_to_employee_id\": null,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1700059519_NNcbnWBX.jpg...\",\n \"u_id\": 1,\n \"first_name\": \"Dimos\",\n \"last_name\": \"Karras\",\n \"email\": \"karras+1@openit.gr\",\n \"job_title_id\": 18,\n \"job_title\": \"Chief Executive Officer\",\n \"user_role\": {\n \"id\": \"1,\",\n \"slug\": \"company-administrator\",\n \"name\": \"Company Administrator\"\n }\n }\n ]\n}"}],"_postman_id":"2670259b-e767-41ca-97f8-80abe78300a1"}],"id":"7b6acda4-b8a0-4d1c-9277-038c166175b3","_postman_id":"7b6acda4-b8a0-4d1c-9277-038c166175b3","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Calendar","item":[{"name":"Get a calendar's filters","id":"28eea834-aa5f-436f-9a87-8da7a8717c3c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/calendar/filters","description":"

API Endpoint to retrieve the available filters for calendar.

\n

This endpoint allows you to fetch a list of valid filters for the system's calendar. Utilize the 'id' field from the returned objects to filter employees in the 'calendar' endpoint.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["calendar","filters"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"5eef8022-ea2d-4c95-b392-5efef6a895a9","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/calendar/filters"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"departments\": [\n {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 7,\n \"name\": \"Research & Development\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 8,\n \"name\": \"Marketing & Sales\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 9,\n \"name\": \"Human Resources\",\n \"object_type\": \"department\"\n }\n ],\n \"divisions\": [\n {\n \"id\": 12,\n \"name\": \"North America\",\n \"object_type\": \"division\"\n },\n {\n \"id\": 13,\n \"name\": \"Europe\",\n \"object_type\": \"division\"\n }\n ],\n \"locations\": [\n {\n \"id\": 33,\n \"name\": \"New York\",\n \"object_type\": \"location\"\n },\n {\n \"id\": 34,\n \"name\": \"California\",\n \"object_type\": \"location\"\n },\n {\n \"id\": 35,\n \"name\": \"London\",\n \"object_type\": \"location\"\n },\n {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\"\n }\n ],\n \"emp_state\": [\n {\n \"id\": 1,\n \"name\": \"Full-Time\",\n \"object_type\": \"employment_status\"\n },\n {\n \"id\": 2,\n \"name\": \"Part-Time\",\n \"object_type\": \"employment_status\"\n }\n ],\n \"time_off_types\": [\n {\n \"id\": 4,\n \"name\": \"Vacation\",\n \"slug\": \"vacation\"\n },\n {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\"\n }\n ],\n \"time_off_status\": [\n \"Approved\",\n \"Pending\"\n ]\n }\n}"}],"_postman_id":"28eea834-aa5f-436f-9a87-8da7a8717c3c"},{"name":"Get calendar's info","id":"87ab31dc-b404-4263-8632-93f4b05fe3a5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/calendar?start_date=&end_date=&employee_id=&filter=","description":"

API Endpoint to retrieve the dates that each employee(s) is off, for the specified date range.

\n

This endpoint retrieves comprehensive information regarding the system's calendar.

\n

The calendar endpoint provides information about employee time off and holidays. Users can filter this information based on various criteria, including pending time-offs, completed time-offs, time-offs for specific divisions, departments, locations, time off types, and employment statuses. Additionally, historical data of time-offs for terminated employees are also available. Besides the filters, you have the option to provide the employee_id parameter to the calendar endpoint. This allows you to specify the employee of your choice and retrieve his/her calendar data.

\n

Note: If the end date is not provided, the calendar period will extend from the start date provided to the end of the month in which the start date falls.

\n
\n

You have the option to utilize filters to precisely retrieve the data you want. You can find suitable IDs for the current filters by accessing the 'directory filters' endpoint. The filters include information regarding time off status, location, division, departments, employment status, and time off types.

\n

Note: Filter options in the filters are represented as arrays of IDs. However, the time off status (as time_off in filters) for the calendar has two options and they are represented as strings: \"pending\" and \"approved\". These can be specified directly in the filters. (E.g. time_off=pending,approved;)

\n

Note: If no filter provided then the calendar will return all the employees (included the terminated) with their time-offs and the holidays for the specified period.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["calendar"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

(Required) Start date (Format can be either of YYYY-MM-DD or YYYY-MM)

\n","type":"text/plain"},"key":"start_date","value":""},{"description":{"content":"

End date (Optional, cannot exceed 2 years after the start date)

\n","type":"text/plain"},"key":"end_date","value":""},{"description":{"content":"

Employee Id

\n","type":"text/plain"},"key":"employee_id","value":""},{"description":{"content":"

Filters for the calendar. Arrays with their Ids (integer) except time_off, which is enum values [pending, approved], ('location' => [], 'department' => [], 'division' => [], 'time_off' => [], 'time_off_type' => [], 'emp_state' => [], 'time_off_status' => []). Example: department=10;location=36,37;division=17;emp_state=1,2,3,5;time_off_type=2;time_off=pending,approved;

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"3030f96a-7667-415e-99e3-3783d06fade6","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/calendar?start_date=&end_date=&employee_id=","host":["https://pubapi.talenthr.io/v1"],"path":["calendar"],"query":[{"key":"start_date","value":""},{"key":"end_date","value":""},{"key":"employee_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"employees\": [\n {\n \"id\": 16,\n \"user_id\": 16,\n \"reports_to_employee_id\": 14,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/16_1700479590.jpg...\",\n \"u_id\": 16,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"division_id\": 13,\n \"division\": \"Europe\",\n \"department_id\": 9,\n \"department\": \"Human Resources\",\n \"job_title_id\": 21,\n \"job_title\": \"Human Resources Manager\",\n \"work_phone\": \"phone-number\",\n \"linked_in_url\": null,\n \"location_id\": 36,\n \"employment_status_id\": 1,\n \"user_role\": {\n \"id\": 2,\n \"name\": \"HR Manager\",\n \"slug\": \"hr-manager\"\n },\n \"holidays\": [\n 11,\n 12\n ],\n \"time_off_request\": [\n {\n \"id\": 9,\n \"employee_id\": 16,\n \"start_date\": \"2023-11-27\",\n \"budget\": \"10.000\",\n \"end_date\": \"2023-12-08\",\n \"timeoff_type_id\": 2,\n \"approved\": true,\n \"allow_cancel\": true,\n \"time_off_type\": {\n \"id\": 2,\n \"name\": \"WFH\",\n \"slug\": \"wfh\"\n }\n }\n ]\n }\n ]\n }\n}"}],"_postman_id":"87ab31dc-b404-4263-8632-93f4b05fe3a5"}],"id":"76230766-f612-4c53-8260-2711d1848b15","_postman_id":"76230766-f612-4c53-8260-2711d1848b15","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Applicant Tracking System (Job Positions)","item":[{"name":"Get all job positions","id":"c5cf88f2-4733-42b3-9b85-bbde3ddb0bf2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions","description":"

API Endpoint to retrieve the available job positions.

\n

This endpoint offers a comprehensive overview of available job positions within the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"1c58f620-aa0d-4226-9073-4b9168f5d7ee","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"job_position_title\": \"job-position-title\",\n \"is_remote\": false,\n \"publish_date\": \"2023-12-11 11:13:32\",\n \"end_date\": null,\n \"slug\": \"job-position-slug\",\n \"job_description\": \"This is a job description...\",\n \"location_id\": 36,\n \"department_id\": null,\n \"employment_status_id\": 1,\n \"job_position_status_id\": 2,\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ],\n \"job_position_status_name\": \"Published\",\n \"job_position_status_slug\": \"published\",\n \"created_at\": \"2023-12-11 11:13:32\",\n \"updated_at\": \"2023-12-11 11:13:32\",\n \"deleted_at\": null,\n \"applied_count\": 1,\n \"processed_count\": 0,\n \"hired_count\": 0,\n \"location_name\": \"Athens\",\n \"location_address\": \"location-address\",\n \"department_name\": null,\n \"employment_status_name\": \"Full-Time\",\n \"has_applications\": true\n }\n ]\n}"}],"_postman_id":"c5cf88f2-4733-42b3-9b85-bbde3ddb0bf2"},{"name":"Create a job position","id":"17eea66b-788b-4af0-a204-6970564ac894","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\", // The current title of the job position. Maximum character limit: 255 characters.\n \"job_position_status\": \"\", // The current status of the job position. Valid values are ['draft','published']\n \"job_description\": \"\", // Maximum character limit: 30000 characters. Required only when the job position status is 'published'.\n \"available_steps\": [ // Array of available steps, for every 5 steps of the system. Each set must include the step's slug (string), name(string), and its enabled status (boolean). All 5 steps must be present.\n { // First Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Second Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Third Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Fourth Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Fifth Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n }\n ],\n \"hiring_team\": [ // Array of employee Ids. This is the hiring team members for the job position.\n \"\",\n \"\"\n ],\n \"department_id\": \"\", // This must be a valid department from the provided 'departments' of the system.\n \"location_id\": \"\", // Required only when the job position status is 'published'. This must be a valid location from the provided 'locations' of the system.\n \"employment_status_id\": \"\", // This must be a valid employment status from the provided 'employment-statuses' of the system. Required only when the job position status is 'published'.\n \"is_remote\": \"\" // 'true' for Remote job Position, 'false' for non-Remote job Position\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions","description":"

API Endpoint to create a new Job Position.

\n

This endpoint facilitates the creation of a new job position. The request body for this endpoint should include a title and a description for the job position, the hiring team, interview steps, location, department, employment status (e.g., Full Time, Part Time), remote option (if applicable for a remote job), and the current status of the job position (draft or published).

\n

Note: Valid options for Location, Department, and Employment Status IDs can be found in the endpoints that return information about the system's 'locations', 'departments', and 'employment statuses'.

\n

Available Steps:

\n

The available steps in the system are predefined and consist of five steps, all of which must be present. They represent the interview process from the initial application stage to the final hiring decision.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StepNameSlug
FirstAppliedapplied
SecondPromisingpromising
ThirdPhone Screenphone-screen
FourthInterviewinterview
FifthHiredhired
\n

Note: The first and fifth steps are always enabled and cannot be disabled. You can only update the names of the steps and the enable property, which indicates whether the step is currently enabled or not.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
job_position_titlestringtrueThe current title of the job position. Maximum character limit: 255 characters.-
job_position_statusenumtrueThe current status of the job position. Valid values are ['draft','published']e.g. draft
job_descriptionstringtrueMaximum character limit: 30000 characters. Required only when the job position status is 'published'.-
available_stepsarraytrueArray of available steps, for every 5 steps of the system. Each step (object) must include the step's slug (string), name(string), and its enabled status (boolean). All 5 steps must be present. The first and the last step cannot be disabled.e.g. [{\"slug\":\"applied\", \"name\":\"Applied\",\"is_enabled\": false},...]
hiring_teamarrayfalseArray of employee Ids (Active and not Terminated employees). This is the hiring team members for the job position.
department_idintegerfalseRequired only when the job position status is 'published'. This must be a valid department from the provided 'departments' of the system.-
location_idintegerfalseRequired only when the job position status is 'published'. This must be a valid location from the provided 'locations' of the system.-
employment_status_idintegerfalseRequired only when the job position status is 'published'. This must be a valid employment status from the provided 'employment-statuses' of the system. Required only when the job position status is 'published'.-
is_remotebooleanfalse'true' for Remote job Position, 'false' for non-Remote job Position-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"5dcf4269-3f49-4194-b042-1e96cfaf4f4e","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\",\n \"job_position_status\": \"\",\n \"job_description\": \"\",\n \"available_steps\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n }\n ],\n \"hiring_team\": [\n 1,\n 2,\n 3\n ],\n \"tone\": \"\",\n \"department_id\": \"\",\n \"location_id\": \"\",\n \"employment_status_id\": \"\",\n \"is_remote\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"job_position_title\": \"job-title\",\n \"department_id\": 42,\n \"employment_status_id\": 1,\n \"location_id\": 36,\n \"is_remote\": false,\n \"job_description\": \"

this is a job description...

\",\n \"publish_date\": null,\n \"end_date\": null,\n \"slug\": \"job-title-slug\",\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Promising\",\n \"slug\": \"promising\",\n \"editable\": 1,\n \"is_enabled\": 0,\n \"sort_order\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Phone Screen\",\n \"slug\": \"phone-screen\",\n \"editable\": 1,\n \"is_enabled\": 0,\n \"sort_order\": 3\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ],\n \"job_position_status_id\": 1,\n \"created_at\": \"2024-02-26 09:29:46\",\n \"updated_at\": \"2024-02-26 09:29:46\",\n \"deleted_at\": null,\n \"tone\": null,\n \"notification_manager_id\": 1,\n \"location_name\": \"Athens\",\n \"location_address\": \"1, Likourgrou Street, Athens, Greece 10551\",\n \"department_name\": \"department-name\",\n \"employment_status_name\": \"Full-Time\",\n \"has_applications\": false,\n \"job_position_status\": {\n \"id\": 1,\n \"slug\": \"draft\",\n \"name\": \"Draft\",\n \"is_enabled\": 1\n }\n }\n}"},{"id":"216d9cb3-3682-4907-960d-6a16053491ed","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\",\n \"job_position_status\": \"\",\n \"job_description\": \"\",\n \"available_steps\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n }\n ],\n \"hiring_team\": [\n 1,\n 2,\n 3\n ],\n \"tone\": \"\",\n \"department_id\": \"\",\n \"location_id\": \"\",\n \"employment_status_id\": \"\",\n \"is_remote\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"17eea66b-788b-4af0-a204-6970564ac894"},{"name":"Get a job position","id":"2fbfaa6f-2dd9-403a-b2f6-2478d3301476","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","description":"

API Endpoint to retrieve a specified job position.

\n

This endpoint retrieves comprehensive information for a specified job position.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"5cee3c69-182d-4af6-a4d9-7d34c71ef3a8","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"5ab38e38-5a79-40b8-a7c8-4c0edd86a5f2","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"job_position_title\": \"job-title\",\n \"department_id\": 42,\n \"employment_status_id\": 1,\n \"location_id\": 36,\n \"is_remote\": false,\n \"job_description\": \"

this is a job description...

\",\n \"publish_date\": null,\n \"end_date\": null,\n \"slug\": \"job-title-slug\",\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Promising\",\n \"slug\": \"promising\",\n \"editable\": 1,\n \"is_enabled\": 0,\n \"sort_order\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Phone Screen\",\n \"slug\": \"phone-screen\",\n \"editable\": 1,\n \"is_enabled\": 0,\n \"sort_order\": 3\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ],\n \"job_position_status_id\": 1,\n \"created_at\": \"2024-02-26 09:29:46\",\n \"updated_at\": \"2024-02-26 09:29:46\",\n \"deleted_at\": null,\n \"tone\": null,\n \"notification_manager_id\": 1,\n \"location_name\": \"Athens\",\n \"location_address\": \"1, Likourgrou Street, Athens, Greece 10551\",\n \"department_name\": \"department-name\",\n \"employment_status_name\": \"Full-Time\",\n \"has_applications\": false,\n \"job_position_status\": {\n \"id\": 1,\n \"slug\": \"draft\",\n \"name\": \"Draft\",\n \"is_enabled\": 1\n },\n \"hiring_team\": [\n {\n \"id\": 19,\n \"job_position_id\": 9,\n \"employee_id\": 15,\n \"created_at\": \"2024-02-26 09:29:46\",\n \"updated_at\": \"2024-02-26 09:29:46\"\n }\n ]\n }\n}"},{"id":"38ff9725-124d-4f4f-ab83-17c917bb74b2","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"2fbfaa6f-2dd9-403a-b2f6-2478d3301476"},{"name":"Update a job position","id":"de457661-644d-4491-beec-a262c7ea561a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\", // The current title of the job position. Maximum character limit: 255 characters.\n \"job_position_status\": \"\", // The current status of the job position. Valid values are ['draft','published']\n \"job_description\": \"\", // Maximum character limit: 30000 characters. Required only when the job position status is 'published'.\n \"available_steps\": [ // Array of available steps, for every 5 steps of the system. Each set must include the step's slug (string), name(string), and its enabled status (boolean). All 5 steps must be present.\n { // First Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Second Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Third Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Fourth Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n },\n { // Fifth Step\n \"slug\": \"\",\n \"name\": \"\",\n \"is_enabled\": \"\"\n }\n ],\n \"hiring_team\": [ // Array of employee Ids. This is the hiring team members for the job position.\n \"\",\n \"\"\n ],\n \"department_id\": \"\", // This must be a valid department from the provided 'departments' of the system.\n \"location_id\": \"\", // Required only when the job position status is 'published'. This must be a valid location from the provided 'locations' of the system.\n \"employment_status_id\": \"\", // This must be a valid employment status from the provided 'employment-statuses' of the system. Required only when the job position status is 'published'.\n \"is_remote\": \"\" // 'true' for Remote job Position, 'false' for non-Remote job Position\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","description":"

API Endpoint to update a specified job position.

\n

This endpoint updates the specified job position. The request body for this endpoint should include a title and a description for the job position, the hiring team, interview steps, location, department, employment status (e.g., Full Time, Part Time), remote option (if applicable for a remote job), and the current status of the job position (draft or published).

\n

Note: Valid options for Location, Department, and Employment Status IDs can be found in the endpoints that return information about the system's 'locations', 'departments', and 'employment statuses'.

\n

Available Steps:

\n

The available steps in the system are predefined and consist of five steps, all of which must be present. They represent the interview process from the initial application stage to the final hiring decision.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StepNameSlug
FirstAppliedapplied
SecondPromisingpromising
ThirdPhone Screenphone-screen
FourthInterviewinterview
FifthHiredhired
\n

Note: The first and fifth steps are always enabled and cannot be disabled. You can only update the names of the steps and the enable property, which indicates whether the step is currently enabled or not.

\n

Note: If at least one applicant has applied for the current job position, the available steps cannot be enabled or disabled (You can change only the name).

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
job_position_titlestringtrueThe current title of the job position. Maximum character limit: 255 characters.-
job_position_statusenumtrueThe current status of the job position. Valid values are ['draft','published']e.g. draft
job_descriptionstringtrueMaximum character limit: 30000 characters. Required only when the job position status is 'published'.-
available_stepsarraytrueArray of available steps, for every 5 steps of the system. Each step (object) must include the step's slug (string), name(string), and its enabled status (boolean). All 5 steps must be present. The first and the last step cannot be disabled.e.g. [{\"slug\":\"applied\", \"name\":\"Applied\",\"is_enabled\": false},...]
hiring_teamarrayfalseArray of employee Ids (Active and not Terminated employees). This is the hiring team members for the job position.
department_idintegerfalseRequired only when the job position status is 'published'. This must be a valid department from the provided 'departments' of the system.-
location_idintegerfalseRequired only when the job position status is 'published'. This must be a valid location from the provided 'locations' of the system.-
employment_status_idintegerfalseRequired only when the job position status is 'published'. This must be a valid employment status from the provided 'employment-statuses' of the system. Required only when the job position status is 'published'.-
is_remotebooleanfalse'true' for Remote job Position, 'false' for non-Remote job Position-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"dcfeb0c3-2f39-4510-9a29-b0fd5db76ab3","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"b068db3b-ae30-42c6-a4b4-5a199d7b8718","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\",\n \"job_position_status\": \"\",\n \"job_description\": \"\",\n \"available_steps\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n }\n ],\n \"hiring_team\": [\n 1,\n 2,\n 3\n ],\n \"tone\": \"\",\n \"department_id\": \"\",\n \"location_id\": \"\",\n \"employment_status_id\": \"\",\n \"is_remote\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 4,\n \"job_position_title\": \"job-title\",\n \"department_id\": 42,\n \"employment_status_id\": 1,\n \"location_id\": 36,\n \"is_remote\": false,\n \"job_description\": \"

this is a job description...

\",\n \"publish_date\": null,\n \"end_date\": null,\n \"slug\": \"job-title-slug\",\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Promising\",\n \"slug\": \"promising\",\n \"editable\": 1,\n \"is_enabled\": 0,\n \"sort_order\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Phone Screen\",\n \"slug\": \"phone-screen\",\n \"editable\": 1,\n \"is_enabled\": 0,\n \"sort_order\": 3\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ],\n \"job_position_status_id\": 1,\n \"created_at\": \"2024-02-26 09:29:46\",\n \"updated_at\": \"2024-02-26 09:29:46\",\n \"deleted_at\": null,\n \"tone\": null,\n \"notification_manager_id\": 1,\n \"location_name\": \"Athens\",\n \"location_address\": \"1, Likourgrou Street, Athens, Greece 10551\",\n \"department_name\": \"department-name\",\n \"employment_status_name\": \"Full-Time\",\n \"has_applications\": false,\n \"job_position_status\": {\n \"id\": 1,\n \"slug\": \"draft\",\n \"name\": \"Draft\",\n \"is_enabled\": 1\n }\n }\n}"},{"id":"631f5795-929e-4090-9117-db52070a4137","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\",\n \"job_position_status\": \"\",\n \"job_description\": \"\",\n \"available_steps\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n }\n ],\n \"hiring_team\": [\n 1,\n 2,\n 3\n ],\n \"tone\": \"\",\n \"department_id\": \"\",\n \"location_id\": \"\",\n \"employment_status_id\": \"\",\n \"is_remote\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"18111c6f-784e-4216-b6bf-a00f657bd9a0","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_title\": \"\",\n \"job_position_status\": \"\",\n \"job_description\": \"\",\n \"available_steps\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"slug\": \"\",\n \"is_enabled\": \"\",\n \"is_editable\": \"\",\n \"sort_order\": \"\"\n }\n ],\n \"hiring_team\": [\n 1,\n 2,\n 3\n ],\n \"tone\": \"\",\n \"department_id\": \"\",\n \"location_id\": \"\",\n \"employment_status_id\": \"\",\n \"is_remote\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"de457661-644d-4491-beec-a262c7ea561a"},{"name":"Delete a job position","id":"09e1d6a7-023f-4cc3-8af5-fe0b0b466734","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","description":"

API Endpoint to delete a specified job position.

\n

This endpoint facilitates the deletion of the specified job position. Upon deletion, any associated notification notes created for the job position are also removed. Additionally, if the job position status was published, it is also removed from the published records of the domain's active career page.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"f06b9138-397d-465f-b8b5-ebf723d4ac1d","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"d22e5a99-1262-411b-9869-74b5c13313bf","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"92971406-f3df-483c-8bd4-4bc756a7df9e","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"09e1d6a7-023f-4cc3-8af5-fe0b0b466734"},{"name":"Get job position's applicants","id":"aa58799a-5b48-43f2-9664-3ec0787083d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants?limit=&offset=&order=&sort=&search=","description":"

API Endpoint to get all the applicants for a specified job position.

\n

This endpoint retrieves comprehensive information regarding the applicants for the specified job position. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, users can customize the order and sorting of the retrieved data or search through them. The search option exclusively searches for first names, last names, and emails.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","ats-applicants"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum ['name', 'created_at']

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Searching

\n","type":"text/plain"},"key":"search","value":""}],"variable":[{"id":"6b816107-4aab-4000-ae73-647decc99e23","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"7f241cdb-54c8-489e-bc00-81d865c082ce","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants?limit=&offset=&order=&sort=&search=","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""}],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 2,\n \"first_name\": \"Susan\",\n \"last_name\": \"Clarke\",\n \"email\": \"sclarke@example.com\",\n \"phone\": \"698745215532\",\n \"address\": \"Random Str 123A, Complex IX\",\n \"created_at\": \"2023-12-11 11:16:50\",\n \"starred\": false,\n \"application\": {\n \"id\": 2,\n \"applicant_id\": 2,\n \"applicants_cv_id\": 2,\n \"job_position_id\": 2,\n \"is_disqualified\": false,\n \"first_name\": \"Susan\",\n \"last_name\": \"Clarke\",\n \"address\": \"Random Str 123A, Complex IX\",\n \"phone\": \"698745215532\",\n \"description\": \"NO\",\n \"application_step_id\": 1,\n \"created_at\": \"2023-12-11 11:16:51\",\n \"updated_at\": \"2023-12-11 11:16:51\",\n \"deleted_at\": null\n },\n \"added_at\": \"2023-12-11\"\n }\n ]\n }\n}"},{"id":"d2d81b68-b406-42be-bcb4-2d55c3b537ee","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants?limit=&offset=&order=&sort=&search=","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""}],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"aa58799a-5b48-43f2-9664-3ec0787083d9"},{"name":"Create an applicant for the job position","id":"9fe5b1c3-a505-4f57-970c-05bd4f628718","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"","description":"

(Required) Maximum character limit: 191 characters.

\n","type":"text"},{"key":"last_name","value":"","description":"

(Required) Maximum character limit: 191 characters.

\n","type":"text"},{"key":"email","value":"","description":"

(Required) Maximum character limit: 191 characters.

\n","type":"text"},{"key":"phone","value":"","description":"

(Required) Maximum character limit: 191 characters.

\n","type":"text"},{"key":"address","value":"","description":"

(Required) Maximum character limit: 191 characters.

\n","type":"text"},{"key":"description","value":"","description":"

(Required) Maximum character limit: 30000 characters.

\n","type":"text"},{"key":"resume","description":"

File. Valid Formats (docx,doc,odt,pdf). The document must not surpass 30MB.

\n","type":"file","value":null}]},"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants","description":"

API Endpoint to create or update an applicant (and his application) for the specified job position.

\n

This endpoint facilitates the creation of a new applicant for the specified job position. The job position must be published. The request body should include applicant's full name (first name and last name), an email, an address, a phone number, a brief description and his/her resume.

\n
    \n
  • If you intend to update the information for the current applicant, you have to use the same email address as it is associated with the applicant's existing record.
    • \n
\n
\n

When an applicant successfully submits their application for a job position, two emails are automatically generated and sent. The first email is sent to the creator of the job position, notifying them that a new applicant has been added to the pool of candidates for the position they created. The second email is dispatched to the applicant, serving as a confirmation of their job application submission.

\n
\n

Filenames within the system must not start with any illegal character or symbol (e.g. @ (at sign), $ (dollar sign), % (percent), & (ampersand)) and should maintain a reasonable length, ensuring they do not exceed 250 characters.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
first_namestringtrueMaximum character limit: 191 characters.
last_namestringtrueMaximum character limit: 191 characters.
emailstringtrueMaximum character limit: 191 characters. Valid email format and structure.
phonestringtrueMaximum character limit: 191 characters.
addressstringtrueMaximum character limit: 191 characters.
descriptionstringtrueMaximum character limit: 30,000 characters.
resumefiletrueFile. Valid Formats (docx,doc,odt,pdf). The document must not surpass 30MB.
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","ats-applicants"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"888decab-b204-4d01-a515-ed644fa9ac77","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"7a8aeea8-8bb2-4934-a5f6-54e4aee93bc3","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"last_name","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"email","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"phone","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"address","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"description","value":"","description":"(Required) Maximum character limit: 30000 characters.","type":"text"},{"key":"resume","value":"","description":"File. Valid Formats (docx,doc,odt,pdf)","type":"text"}]},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 33089509,\n \"first_name\": \"et exercitation cons\",\n \"last_name\": \"i\",\n \"email\": \"amet velit consectetur laboris\",\n \"phone\": \"sit\",\n \"description\": \"deserunt sit nisi ess\",\n \"starred\": true,\n \"address\": \"incididunt exercitation de\",\n \"latest_cv_id\": 50036183,\n \"created_at\": \"2024-01-20 00:00:00\",\n \"updated_at\": \"2024-01-20 00:00:00\",\n \"deleted_at\": \"2024-01-20 00:00:00\"\n }\n}"},{"id":"d4ead182-ad8a-424d-805c-632bf47210e2","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"last_name","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"email","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"phone","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"address","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"description","value":"","description":"(Required) Maximum character limit: 30000 characters.","type":"text"},{"key":"resume","value":"","description":"File. Valid Formats (docx,doc,odt,pdf)","type":"text"}]},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"30238975-d20e-49ee-8577-c20499df1228","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"first_name","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"last_name","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"email","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"phone","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"address","value":"","description":"(Required) Maximum character limit: 191 characters.","type":"text"},{"key":"description","value":"","description":"(Required) Maximum character limit: 30000 characters.","type":"text"},{"key":"resume","value":"","description":"File. Valid Formats (docx,doc,odt,pdf)","type":"text"}]},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"9fe5b1c3-a505-4f57-970c-05bd4f628718"},{"name":"Update Applicant State","id":"c2c204ee-dce4-4b06-bcdb-40b033d31f62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_disqualified\": \"\" // If this it's 'true' then the applicant is being disqualified, otherwise opt for 'false'.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants/:objectId","description":"

API Endpoint to disqualify/return to candidates a candidate for a specified job position.

\n

This endpoint facilitates the movement of the current applicant to the disqualified candidates list for the specific step they are in or back to consideration for the current job position.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
is_disqualifiedbooleantrueIf this is 'true' then the applicant is being disqualified, otherwise, opt for 'false'.e.g. true
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","ats-applicants",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"6be8b98c-d03d-4286-8ed6-f3eb4c1d0e7e","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"},{"id":"19a4b1a6-c1ff-4c93-b987-469f4191d85f","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"234b7fc8-3a81-42c0-ac89-42b0c8d5709e","name":"Simple boolean response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_disqualified\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"c89c284f-5988-4e8e-96d2-d887ff906af2","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_disqualified\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"e061358f-0b43-49e4-ad48-9a743504ab75","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"is_disqualified\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applicants",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"c2c204ee-dce4-4b06-bcdb-40b033d31f62"},{"name":"Get an application","id":"f8c2493d-ab2b-4234-baf0-ec4f800a000b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","description":"

API Endpoint to retrieve a specified application for a job position.

\n

This endpoint provides detailed information about the employee's application for the specified job position. It includes general information about the applicant, details regarding the job position, available steps within the application process, the current application step, and any associated notes from the hiring team.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","ats-applications",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"049167be-07c2-4094-aa24-4d94ea428904","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"},{"id":"680ee8fb-dffc-4455-b729-6f6e224d92b0","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"fe3d193b-3027-4ad3-bff4-95654636adb8","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"applicant_id\": 2,\n \"applicants_cv_id\": 2,\n \"job_position_id\": 2,\n \"is_disqualified\": false,\n \"first_name\": \"Susan\",\n \"last_name\": \"Clarke\",\n \"address\": \"address-name\",\n \"phone\": \"phone-number\",\n \"description\": \"This is a description...\",\n \"application_step_id\": 2,\n \"created_at\": \"2023-12-11 11:16:51\",\n \"updated_at\": \"2024-02-27 08:19:33\",\n \"deleted_at\": null,\n \"application_date\": \"2023-12-11 13:16:51\",\n \"application_step_slug\": \"promising\",\n \"job_position\": {\n \"id\": 2,\n \"job_position_title\": \"job-position-name\",\n \"slug\": \"job-position-slug\",\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Promising\",\n \"slug\": \"promising\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Phone Screen\",\n \"slug\": \"phone-screen\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 3\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ]\n },\n \"applicant\": {\n \"id\": 2,\n \"first_name\": \"Susan\",\n \"last_name\": \"Clarke\",\n \"email\": \"sclarke@example.com\",\n \"starred\": false\n },\n \"applicant_cv\": {\n \"id\": 2,\n \"applicant_id\": 2,\n \"client_filename\": \"resume.pdf\",\n \"filename\": \"/domain/applicants_cvs/1702293410_Resume.pdf\",\n \"filetype\": \"pdf\",\n \"created_at\": \"2023-12-11 11:16:51\",\n \"updated_at\": \"2023-12-11 11:16:51\",\n \"deleted_at\": null,\n \"master_id\": null,\n \"preview_filename\": null,\n \"cv_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/applicants_cvs/1702293410_Resume2.pdf?Expires=1709025658&Signature=AIPNSrCplACkQiSpUBOZGpEPFbaxQQ6bRrKbz2rBkDC6xFrUKYTG9qd5Y0NWozSmNPvA2IA7TE53nN00gxMpojrcFPoFF1T1RVCCByn-4NPj0mQXfqNMKQhnNj-di-iLDNSgODJxM0wM650yTRlU8cj0JeDCbU-RP9mNydkQruh2~-VshcftlgBONcMfcqBhe-GybJIHCrpmhS9U8ktlYl55voLFK5G0l2Wv2qqk5tN7a~QijtsaNRgsGr6F6u6QaHqStNTkAmJfPMKGUgMGMsywLEiS-OnTz-7rv5BYqQ6-uYXF0mf-0I-58tI8ZtYs4co0bfVUvkstc1QSEv1KDQ__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"preview_cv_url\": null\n },\n \"application_notes\": [\n {\n \"id\": 10,\n \"applicant_id\": 2,\n \"application_id\": 2,\n \"commentor_id\": 1,\n \"job_position_id\": 2,\n \"note_text\": \"...updated 3rd time...\",\n \"created_at\": \"2024-01-31 12:27:16\",\n \"updated_at\": \"2024-01-31 12:27:16\",\n \"deleted_at\": null,\n \"commentor_full_name\": \"John Doe\",\n \"commentor_job_title_name\": \"Chief Executive Officer\",\n \"commentor_role\": {\n \"id\": 1,\n \"name\": \"Company Administrator\",\n \"slug\": \"company-administrator\"\n },\n \"commentor_photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1700059519_NNcbnWBX.jpg?Expires=1709108458&Signature=LfEF9vqhIffIawCFOx0su2h4aC1nhFIayFLmb1vE3IR8mbuKsX5aM83Lf-aAFsvWc-Qlpfxkg2ooj9Wags2hxC5sY9i4qYtuKuKew5-oDt~xurK-TLj1~AiaHTN5~H~sXS~00QBudn0SyvRIbZptUXfFc-MeoGS-x04qMz-DAPg-04dTVBYWDtak9lHjlRNMkjnWuUW4uGTWAYqR0qc1nf65FGYHKUe30ndNYnN5cwMdBkOiG-nQb8ohoSBkvNQpAOR6dG3ptnmN79lUYQxZTUjGrDMehAN29MHIZLZlEkwCzU72E0JXmraz7YU~pPCcfzmy2KUHROaWlpNWK413YQ__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"note_date\": \"2024-01-31 14:27:16\"\n }\n ],\n \"application_step\": {\n \"id\": 2,\n \"slug\": \"promising\",\n \"name\": \"Promising\",\n \"is_enabled\": 1,\n \"editable\": 1,\n \"sort_order\": 2\n }\n }\n}"},{"id":"fcae23cb-53af-49bf-b93c-665b1c2b2c24","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"f8c2493d-ab2b-4234-baf0-ec4f800a000b"},{"name":"Update an application","id":"920661f8-4300-41d8-99e2-8897ee7ae234","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"step_slug\": \"\" // (Required). The slug of an available job position step that is enable. To inspect and update the step_slug you're interested in, you can review all available steps of the application through the 'Get an application' endpoint.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","description":"

API Endpoint to update an application for a specified job position (change step).

\n

This endpoint allows for the modification of the current step of an applicant's application for the specified job position. The step slug is generated from the name of the specified step. To view and update the 'step_slug' you're interested in, you can see the availabe steps of the system below.

\n

Available Steps:

\n

The available steps in the system are predefined and consist of five steps, all of which must be present. They represent the interview process from the initial application stage to the final hiring decision.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
StepNameSlug
FirstAppliedapplied
SecondPromisingpromising
ThirdPhone Screenphone-screen
FourthInterviewinterview
FifthHiredhired
\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
step_slugstringtrueThe slug of an available job position step that is enabled. To inspect and update the step_slug you're interested in, you can review all available steps of the application through the 'Get an application' or 'get a job position' endpoint-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","ats-applications",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"63b97ddf-b5e2-4435-a67a-5269f3af5d2c","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"},{"id":"99739393-03de-44c5-b12e-e7a9be0ee072","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"d3622c63-6e19-49e9-938d-d1ff59730da0","name":"Simple boolean response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"step_slug\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"611ab284-742d-4183-bdb9-fc1b74ed0732","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"step_slug\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"9d157822-e23c-4c03-928e-cc26aaba6adb","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"step_slug\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"920661f8-4300-41d8-99e2-8897ee7ae234"},{"name":"Create an application note","id":"4dc908dd-2304-4089-abf9-fe0e10c83024","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note_text\": \"\" // Required field. Maximum character limit: 30000 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId/notes","description":"

API Endpoint to create a note for a specific job application.

\n

In this endpoint, members of the hiring team are able to create notes for the employee's application for the specified job position. Note creation is not restricted solely to members of the hiring team; other roles, such as Company admin or HR-manager, do have this capability. The request body should contain a note text.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
note_textstringtrueMaximum character limit: 30000 characters.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","ats-applications",":objectId","notes"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"0ba31ed5-2912-4bc4-8af4-726c7ec7af28","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"},{"id":"7543f46f-e76e-4e2c-9cb3-f5c2537d9add","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"3623b48e-94b6-4286-a4d1-9ca442e530bd","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note_text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId/notes","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId","notes"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 12,\n \"applicant_id\": 2,\n \"application_id\": 2,\n \"commentor_id\": 1,\n \"job_position_id\": 2,\n \"note_text\": \"This is a note...\",\n \"created_at\": \"2024-02-27 09:55:28\",\n \"updated_at\": \"2024-02-27 09:55:28\",\n \"deleted_at\": null,\n \"commentor_full_name\": \"John Doe\",\n \"commentor_job_title_name\": \"Chief Executive Officer\",\n \"commentor_role\": {\n \"id\": 1,\n \"name\": \"Company Administrator\",\n \"slug\": \"company-administrator\"\n },\n \"commentor_photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/1700059519_N...\",\n \"note_date\": \"2024-02-27 09:55:28\"\n }\n}"},{"id":"59e97fa7-1f32-4a75-ba73-680d5947855d","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note_text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId/notes","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId","notes"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"89a9b276-ee74-4562-84f5-544b02a871fa","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"note_text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/ats-applications/:objectId/notes","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","ats-applications",":objectId","notes"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"4dc908dd-2304-4089-abf9-fe0e10c83024"},{"name":"Clone a job position","id":"1b93026f-b100-46fa-8a63-dae9f4274ab7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/clone","description":"

API Endpoint to clone a specified job position.

\n

This endpoint allows for the cloning of an existing job position. The job position being cloned must be valid and must already exist within the system.

\n
    \n
  • When cloning a job position in a published status, the cloned job position will not retain the published status. Instead, it will be created as a draft one.
    • \n
  • When cloning an archived job position, the cloned job position will be in the active ones with 'draft' status.
    • \n
\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","clone"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"7201f0ff-8be5-492b-8586-f3055b176a92","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"8d76dfb7-a159-441b-885c-2331a79ca3b8","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/clone","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","clone"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 10,\n \"job_position_title\": \"job-position-name (Copy)\",\n \"department_id\": null,\n \"employment_status_id\": 1,\n \"location_id\": 36,\n \"is_remote\": false,\n \"job_description\": \"This is a job description...\",\n \"publish_date\": \"2023-12-11 11:13:32\",\n \"end_date\": null,\n \"slug\": \"job-position-slug\",\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Promising\",\n \"slug\": \"promising\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Phone Screen\",\n \"slug\": \"phone-screen\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 3\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ],\n \"job_position_status_id\": 1,\n \"created_at\": \"2024-02-27 10:43:02\",\n \"updated_at\": \"2024-02-27 10:43:02\",\n \"deleted_at\": null,\n \"tone\": \"balanced\",\n \"notification_manager_id\": 1\n }\n}"},{"id":"2cfc3383-9afd-4374-9491-c85152dbeecd","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/clone","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","clone"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"33e1757d-c8f3-4305-8252-9d85c919e7ac","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/clone","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","clone"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"1b93026f-b100-46fa-8a63-dae9f4274ab7"},{"name":"Alter Job Position Status","id":"a648c430-9e1e-471b-9c82-0976a3d50e1d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_status\": \"\" // The current status of the job position. Valid values are ['draft', 'archived']\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/change-status","description":"

API Endpoint to archive or draft a specified job position.

\n

This endpoint allows for the alteration of the status of the specified job position from archived to draft and vice versa.

\n

Note: If a job changes its status from published to archived, the current job position will be unpublished.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
job_position_statusstringtrueThe current status of the job position.
Valid values are ;['draft', 'archived']		e.g. draft
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions",":jobPosition","change-status"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"2ebf3aa9-fb9c-48ea-83ea-7408fbdc4830","description":{"content":"

(Required) The job position's Id.

\n","type":"text/plain"},"type":"any","value":"","key":"jobPosition"}]}},"response":[{"id":"879af434-2a55-46a0-802d-5f13bda89740","name":"Simple boolean response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/change-status","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","change-status"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"88521340-fbd4-4fd6-91ce-149b1bc55a67","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/change-status","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","change-status"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"5762f24c-28ac-4e3e-ae45-b8788d2aa222","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"job_position_status\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-positions/:jobPosition/change-status","host":["https://pubapi.talenthr.io/v1"],"path":["job-positions",":jobPosition","change-status"],"variable":[{"key":"jobPosition","value":"","description":"(Required) The job position's Id."}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"a648c430-9e1e-471b-9c82-0976a3d50e1d"},{"name":"Get all published job positions","id":"68ed940e-2ea4-4416-9a35-503afc5bc3a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/published","description":"

API Endpoint to retrieve published job positions.

\n

This endpoint retrieves comprehensive information on all published job positions for the current domain.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-positions","published"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"192e9a1f-5ece-49ea-a9b5-5bc16ae786d3","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/published"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"job_position_title\": \"job-position-name\",\n \"is_remote\": false,\n \"publish_date\": \"2024-02-27 11:51:19\",\n \"end_date\": null,\n \"slug\": \"job-position-slug\",\n \"job_description\": \"This is a description...\",\n \"location_id\": 36,\n \"department_id\": null,\n \"employment_status_id\": 1,\n \"job_position_status_id\": 2,\n \"available_steps\": [\n {\n \"id\": 1,\n \"name\": \"Applied\",\n \"slug\": \"applied\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 1\n },\n {\n \"id\": 2,\n \"name\": \"Promising\",\n \"slug\": \"promising\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 2\n },\n {\n \"id\": 3,\n \"name\": \"Phone Screen\",\n \"slug\": \"phone-screen\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 3\n },\n {\n \"id\": 4,\n \"name\": \"Interview\",\n \"slug\": \"interview\",\n \"editable\": 1,\n \"is_enabled\": 1,\n \"sort_order\": 4\n },\n {\n \"id\": 5,\n \"name\": \"Hired\",\n \"slug\": \"hired\",\n \"editable\": 0,\n \"is_enabled\": 1,\n \"sort_order\": 5\n }\n ],\n \"job_position_status_name\": \"Published\",\n \"job_position_status_slug\": \"published\",\n \"created_at\": \"2023-12-11 11:13:32\",\n \"updated_at\": \"2024-02-27 11:51:19\",\n \"deleted_at\": null,\n \"applied_count\": 0,\n \"processed_count\": 1,\n \"hired_count\": 0,\n \"location_name\": \"Athens\",\n \"location_address\": \"1, Likourgrou Street, Athens, Greece 10551\",\n \"department_name\": null,\n \"employment_status_name\": \"Full-Time\",\n \"has_applications\": true\n }\n ]\n}"},{"id":"561b182d-a7e4-4723-9114-a411d837b18d","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-positions/published"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"68ed940e-2ea4-4416-9a35-503afc5bc3a1"}],"id":"6ae68ede-8c09-4023-b197-73e62f598227","description":"

To use this feature requires that your subscription for TalentHR supports the respective component.

\n","_postman_id":"6ae68ede-8c09-4023-b197-73e62f598227","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Applicant Tracking System","item":[{"name":"Get all the candidates","id":"94264a53-3741-4608-9f3d-87682bb2ee42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/ats-applicants?limit=&offset=&order=&sort=&search=&pool=","description":"

API Endpoint to get all the candidates.

\n

This endpoint retrieves comprehensive information on all domain candidates for the job positions. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n

In addition to pagination parameters, users can customize the order and sorting of the retrieved data or search through them. The search option exclusively searches for first names, last names, and emails.

\n

Furthermore, the candidates' endpoint offers the option to retrieve only the favorite applicants within our domain (applicants that have been starred) when opting for the pool option.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["ats-applicants"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum values ['asc','desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum values ['name', 'created_at']

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Searching

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

If '1' see only favorite applicants, else if '0' see all applicants

\n","type":"text/plain"},"key":"pool","value":""}],"variable":[]}},"response":[{"id":"70b0d859-7e6d-47af-bcf9-0274ddd49bd3","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/ats-applicants?limit=&offset=&order=&sort=&search=&pool=","host":["https://pubapi.talenthr.io/v1"],"path":["ats-applicants"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""},{"key":"pool","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 2,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"0030 6985*******\",\n \"address\": \"address-name\",\n \"created_at\": \"2023-12-11 11:16:50\",\n \"updated_at\": \"2023-12-11 11:16:51\",\n \"deleted_at\": null,\n \"starred\": false,\n \"applications_count\": 1,\n \"added_at\": \"2023-12-11\"\n }\n ]\n }\n}"}],"_postman_id":"94264a53-3741-4608-9f3d-87682bb2ee42"},{"name":"Get an applicant","id":"833a9f06-2343-4d29-b684-3c54ec780a96","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/ats-applicants/:objectId","description":"

API Endpoint to retrieve a specified candidate (all his applications are included).

\n

This endpoint provides comprehensive information about the specified applicant. It includes brief details about the applicant as well as information about the applications he/she is submitted and the step he/she is in for all the job positions in the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["ats-applicants",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"5375b8d8-0d38-4d9b-a9bd-9c823aa4734f","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"42b63fc4-46b4-4774-b097-3113d768fed1","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["ats-applicants",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\\\"\": 1,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"email\": \"jdoe@example.com\",\n \"phone\": \"phone-number\",\n \"description\": \"This is a description...\",\n \"starred\": false,\n \"address\": \"address-name\",\n \"latest_cv_id\": 1,\n \"created_at\": \"2023-11-15 14:58:52\",\n \"updated_at\": \"2023-11-15 14:59:13\",\n \"deleted_at\": null,\n \"latest_application_id\": 1,\n \"applications_count\": 1,\n \"added_at\": \"2023-11-15\",\n \"applications\": [\n {\n \"id\": 1,\n \"job_position_id\": 1,\n \"applicant_id\": 1,\n \"application_step_id\": 5,\n \"application_step_slug\": \"hired\",\n \"application_step\": {\n \"id\": 5,\n \"slug\": \"hired\",\n \"name\": \"Hired\",\n \"is_enabled\": 1,\n \"editable\": 0,\n \"sort_order\": 5\n }\n }\n ],\n \"latest_cv\": {\n \"id\": 1,\n \"applicant_id\": 1,\n \"client_filename\": \"Resume2.pdf\",\n \"filename\": \"/testdomain1/applicants_cvs/1700060332_Resume2.pdf\",\n \"filetype\": \"pdf\",\n \"created_at\": \"2023-11-15 14:58:57\",\n \"updated_at\": \"2023-11-15 14:58:57\",\n \"deleted_at\": null,\n \"master_id\": null,\n \"preview_filename\": null,\n \"cv_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/applicants_cvs/1700060332_Resume2.pdf?Expires=1708949231&Signature=hMildweXtyS201~fB~a7CXGwerbSxOzuBJf-xdGY1Xis4AYyasAIuXnX~QD5LUb6TqlcsQenrK3hoqzAGatxJoZSqn2ID82ToMeW9RhJpPf3EDOVCUVqvF0a0V5yZDS5cPjyh4~NbjfCyw-0ai2RMBkXnIUkCpGx7gPG6crbjKfFM08UBsqNGNZKYySUmJX--B1ceDGCIqZ~ABnc4hVey4FWNUXlO-Yn4bWVIpi8~nmFFT7KmdhLAKvY7ZD-c6VAOa-BSceCfJb8ccURpfc8n8n9uCFob0s6cX90pz29NFX0vZ985pKIgjpNyfhQi05nd4sLsxzB-k6sRHKL1MRumQ__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"preview_cv_url\": null\n }\n }\n}"},{"id":"8dbbbfb6-4614-4cb3-90ce-3d31ff796e20","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["ats-applicants",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"833a9f06-2343-4d29-b684-3c54ec780a96"},{"name":"Delete an applicant","id":"9cc1fad8-39d4-4270-b5ad-b9f17a54e1d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/ats-applicants/:objectId","description":"

API Endpoint to remove a candidate.

\n

This endpoint facilitates the deletion of the specified applicant. Upon deletion, the associated applications, cv and application notes for this candidate will also be removed.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["ats-applicants",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"aa42c012-679d-4cdf-85a7-a237552b0645","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"7f86ab77-1c30-4b47-b15a-6744e3e3c69c","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["ats-applicants",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"627a2cee-244d-47e1-a36c-e3e8044f0d79","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/ats-applicants/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["ats-applicants",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"9cc1fad8-39d4-4270-b5ad-b9f17a54e1d5"}],"id":"2cc074fc-c14f-4e64-8bc5-074c12d94528","_postman_id":"2cc074fc-c14f-4e64-8bc5-074c12d94528","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Locations","item":[{"name":"Get all the locations","id":"4e880b05-33a5-48d9-969b-6b5ca001b925","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/locations","description":"

API endpoint to get all available locations.

\n\n

This endpoint retrieves a list of all available locations.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["locations"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"8997006b-fa77-44f5-aeb6-06873e088bce","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 34,\n \"name\": \"California\",\n \"object_type\": \"location\",\n \"field_data\": {\n \"address\": \"address-name\",\n \"is_remote\": false\n }\n },\n {\n \"id\": 35,\n \"name\": \"London\",\n \"object_type\": \"location\",\n \"field_data\": {\n \"address\": \"address-name\",\n \"is_remote\": true\n }\n }\n ]\n}"}],"_postman_id":"4e880b05-33a5-48d9-969b-6b5ca001b925"},{"name":"Create a location","id":"44d36dd5-8845-4098-957e-c79ce5d12ff0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field. Maximum character limit: 255 characters. The name must be unique.\n \"field_data\": { // Required field. Object with properties address and is_remote.\n \"address\": \"\", // The address is required with maximum character limit: 100 characters.\n \"is_remote\":\"\" // THe is_remote is required.\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/locations","description":"

API endpoint to create a new location.

\n\n

This endpoint facilitates the creation of a new location. You should provide the name which should be unique, an address, and specify whether the position for this location is remote work.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameNameRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g London
field_dataobjecttrueObject with properties address and is_remote. The address is required with maximum character limit: 100 characters. The is_remote is boolean and required.e.g.
\"field_data\":{
\"address\":\" 21 Main Street\",
\"is_remote\":false
}
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["locations"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"59b06070-0e74-47d6-b9b9-3956cd09f9e1","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"location-name\",\n \"field_data\": \"{\\\"address\\\":\\\"address-name\\\",\\\"is_remote\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/locations"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 34,\n \"name\": \"California\",\n \"object_type\": \"location\",\n \"field_data\": {\n \"address\": \"address-name\",\n \"is_remote\": false\n }\n }\n}"},{"id":"870846dc-aa52-4641-b271-d1a5ba4caa43","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"location-name\",\n \"field_data\": \"{\\\"address\\\":\\\"address-name\\\",\\\"is_remote\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/locations"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"44d36dd5-8845-4098-957e-c79ce5d12ff0"},{"name":"Get a location","id":"afcf28bb-a97c-4a10-bee2-949b72510b25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/locations/:objectId","description":"

API endpoint to fetch the information for a specific location.

\n\n

This endpoint retrieves the specified location from the system's 'locations'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["locations",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b88e5112-44a9-47ec-ba8d-ca1e9d91a81c","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c554e324-3648-4382-a9c9-64be7c556f79","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 34,\n \"name\": \"California\",\n \"object_type\": \"location\",\n \"field_data\": {\n \"address\": \"address-name\",\n \"is_remote\": false\n }\n }\n}"},{"id":"03976d08-d820-4932-80de-a98552e870d4","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"afcf28bb-a97c-4a10-bee2-949b72510b25"},{"name":"Update a location","id":"c517de21-64eb-479f-bb71-82d9a198a045","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field. Maximum character limit: 255 characters. The name must be unique.\n \"field_data\": { // Required field. Object with properties address and is_remote.\n \"address\": \"\", // The address is required with maximum character limit: 100 characters.\n \"is_remote\":\"\" // THe is_remote is required.\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/locations/:objectId","description":"

API endpoint to update the specified location.

\n\n

This endpoint updates the specified location. You should provide the name which should be unique, an address, and specify whether the position for this location is remote work.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameNameRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g London
field_dataobjecttrueObject with properties address and is_remote. The address is required with maximum character limit: 100 characters. The is_remote is boolean and required.e.g.
\"field_data\":{
\"address\":\" 21 Main Street\",
\"is_remote\":false
}
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["locations",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"bfd473b2-d757-461d-948d-921c8ecf39e9","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"5b51159e-110c-4292-a1ab-16f9eb910525","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"location-name\",\n \"field_data\": \"{\\\"address\\\":\\\"address-name\\\",\\\"is_remote\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 34,\n \"name\": \"California\",\n \"object_type\": \"location\",\n \"field_data\": {\n \"address\": \"address-name\",\n \"is_remote\": false\n }\n }\n}"},{"id":"57eca98a-e37d-47d6-bb4a-1013cd8a1510","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"location-name\",\n \"field_data\": \"{\\\"address\\\":\\\"address-name\\\",\\\"is_remote\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"9be60705-e092-481f-98b6-79eedf3b238b","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"location-name\",\n \"field_data\": \"{\\\"address\\\":\\\"address-name\\\",\\\"is_remote\\\":true}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"c517de21-64eb-479f-bb71-82d9a198a045"},{"name":"Delete a location","id":"052aabbe-30e0-42c8-ab67-5f76be1da53a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/locations/:objectId","description":"

API endpoint to delete the specified location.

\n\n

This endpoint deletes the specified location. However, if the location is associated with an active job position record or an active job position record in the Applicant Tracking System (ATS), the deletion cannot proceed.

\n

Furthermore, when a location record is deleted, any associated benefits, performance reviews, holidays, tasks, and employee asset assignments linked to the location are updated accordingly, removing the location attribute from these records.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["locations",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"7e579eda-f510-455e-befc-0c37b33c1ead","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"0dbb3e7c-953d-4470-9820-8f7679bef1d5","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"9f30ad26-7ade-4d67-be78-9088b69ec261","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/locations/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["locations",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"052aabbe-30e0-42c8-ab67-5f76be1da53a"}],"id":"93342f0a-0626-497c-81ba-d993cb141627","_postman_id":"93342f0a-0626-497c-81ba-d993cb141627","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Divisions","item":[{"name":"Get all the divisions","id":"c6ca23d7-8331-46d8-b78f-77fe3c36fd3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/divisions","description":"

API endpoint to get all available divisions.

\n\n

This endpoint retrieves a list of all available divisions.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["divisions"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"bdc97fcf-02c5-4af4-b07c-b5f07208ae83","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/divisions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 12,\n \"name\": \"North America\",\n \"object_type\": \"division\"\n },\n {\n \"id\": 13,\n \"name\": \"Europe\",\n \"object_type\": \"division\"\n }\n ]\n}"}],"_postman_id":"c6ca23d7-8331-46d8-b78f-77fe3c36fd3d"},{"name":"Create a division","id":"0a946c7e-91d6-4d9e-9012-27eebbcbc920","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Required field. Maximum character limit: 255 characters. The name must be unique.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/divisions","description":"

API endpoint to create a new division.

\n\n

This endpoint facilitates the creation of a new division. You should provide the name for the current division which should be unique.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g. Europe
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["divisions"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"bfdae87b-f102-479b-83d6-0e29f737b15d","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"division-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/divisions"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 12,\n \"name\": \"North America\",\n \"object_type\": \"division\"\n }\n}"},{"id":"2916b7e4-41e3-490d-b3e1-f5b893e16ffd","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"division-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/divisions"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"0a946c7e-91d6-4d9e-9012-27eebbcbc920"},{"name":"Get a division","id":"1767849f-e9d6-40e3-9024-d19edfae7c33","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/divisions/:objectId","description":"

API endpoint to fetch a specific division.

\n\n

This endpoint retrieves the specified division from the system's 'divisions'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["divisions",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"fe38fcb1-1c30-4a77-bf95-a772673c5e4d","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"27aff1a3-9fd6-4c6f-8c3a-95da239e36d6","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 12,\n \"name\": \"North America\",\n \"object_type\": \"division\"\n }\n}"},{"id":"c8eb4779-e8a4-41ec-add4-67aa157c4901","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"1767849f-e9d6-40e3-9024-d19edfae7c33"},{"name":"Update a division","id":"aff24708-0102-4f32-b8f5-deccff71235b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Required field. Maximum character limit: 255 characters. The name must be unique.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/divisions/:objectId","description":"

API endpoint to update the specified division.

\n\n

This endpoint updates the specified division. You should provide the name of the current division which should be unique.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g. Europe
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["divisions",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"30b284e5-1332-41df-9103-7e3918ae4ced","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"706a979a-ca9e-4b66-b6e6-8b7cfac8b0f9","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"division-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 12,\n \"name\": \"North America\",\n \"object_type\": \"division\"\n }\n}"},{"id":"4f964614-f22c-47f8-94d2-d2218e450796","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"division-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"dea8d2a7-6106-4912-981d-7c70e2e4f0aa","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"division-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"aff24708-0102-4f32-b8f5-deccff71235b"},{"name":"Delete a division","id":"21b5165c-6c93-4529-9893-fbb712e3c14f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/divisions/:objectId","description":"

API endpoint to delete the specified division.

\n\n

This endpoint deletes the specified division. However, if the division is associated with an active job position record, the deletion cannot proceed.

\n

Furthermore, when a divison record is deleted, any associated benefits, performance reviews, holidays, tasks, and employee asset assignments linked to the location are updated accordingly, removing the division attribute from these records.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["divisions",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"6bf9d325-b924-4129-9324-35d7a0e26bbb","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c06c40e8-35d0-45c3-ae09-8df731d47ca0","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"0e529769-e8e1-42f1-9a43-f62b7a792234","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/divisions/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["divisions",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"21b5165c-6c93-4529-9893-fbb712e3c14f"}],"id":"7c6092c7-4c5b-496b-8b72-f17108db4fec","_postman_id":"7c6092c7-4c5b-496b-8b72-f17108db4fec","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Departments","item":[{"name":"Get all the departments","id":"03ff1c3f-881b-4aae-bf22-b30cc5c270d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/departments","description":"

API endpoint to get all available departments.

\n\n

This endpoint retrieves a list of all available departments.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["departments"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"79ea9ed1-909f-4fb9-9e49-fa44488cff34","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/departments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n },\n {\n \"id\": 7,\n \"name\": \"Research & Development\",\n \"object_type\": \"department\"\n }\n ]\n}"}],"_postman_id":"03ff1c3f-881b-4aae-bf22-b30cc5c270d3"},{"name":"Create a department","id":"021b8cb1-eae0-4736-b846-94a46d0a0697","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Required field. Maximum character limit: 255 characters. The name must be unique.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/departments","description":"

API endpoint to create a new department.

\n\n

This endpoint facilitates the creation of a new department. You should provide the name for the current department which should be unique.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeAttributesDescriptionValues
namestringrequiredMaximum character limit: 255 characters. Name must be unique.e.g
Customer Service
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["departments"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"f7a5847a-aa21-429f-a64f-0811b8436a6c","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"department-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/departments"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n }\n}"},{"id":"aa69278a-d1ea-4a15-ac2d-f6a9cd0790b0","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"department-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/departments"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"021b8cb1-eae0-4736-b846-94a46d0a0697"},{"name":"Get a department","id":"1e5601e9-1a6a-4b36-ad77-6969a86b2130","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/departments/:objectId","description":"

API endpoint to fetch the information for department.

\n\n

This endpoint retrieves the specified department from the system's 'departments'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["departments",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"3b51f1bb-b232-42fc-a60b-1e713988d6d4","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"fb593daf-338d-4f89-a3d3-0b0cf16a7256","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n }\n}"},{"id":"70e6be8b-e04e-400f-9f7c-a3b4a6288a5c","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"1e5601e9-1a6a-4b36-ad77-6969a86b2130"},{"name":"Update a department","id":"9abcef59-819c-4c22-9c21-77701c762594","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Required field. Maximum character limit: 255 characters. The name must be unique.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/departments/:objectId","description":"

API endpoint to update the specified department.

\n\n

This endpoint updates the specified department. You should provide the name of the current department which should be unique.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g
Customer Service
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["departments",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"83687b00-2381-4fb4-808b-8a89b566557b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"e282cdf5-156f-406f-8536-59bdcf7b2c2c","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"department-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\",\n \"object_type\": \"department\"\n }\n}"},{"id":"593e09c4-3bb1-4856-a457-8f14f2a18bc7","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"department-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"52dffcba-93c7-4f24-879d-9feef558ad10","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"department-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"9abcef59-819c-4c22-9c21-77701c762594"},{"name":"Delete a department","id":"806a11fc-5bba-45e9-a441-590d3318502c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/departments/:objectId","description":"

API endpoint to delete the specified department.

\n\n

This endpoint deletes the specified department. However, if the department is associated with an active job position record or an active job position record in the Applicant Tracking System (ATS), the deletion cannot proceed.

\n

Furthermore, when a department record is deleted, any associated benefits, performance reviews, holidays, tasks, and employee asset assignments linked to the location are updated accordingly, removing the department attribute from these records.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["departments",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"813fa992-44cb-4ab4-8d0b-02700e743631","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"6624abc4-f4f7-4d7d-936a-caa69f6dd689","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"0d7f5f34-9909-4712-8f68-6d53cab8f121","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/departments/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["departments",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"806a11fc-5bba-45e9-a441-590d3318502c"}],"id":"501ba61f-53a0-48c8-9f6a-bd382014f29b","_postman_id":"501ba61f-53a0-48c8-9f6a-bd382014f29b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Job Titles","item":[{"name":"Get all the job titles","id":"6626b153-e7fe-4a73-b90f-4c2a6b433327","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-titles","description":"

API endpoint to get all available job titles.

\n\n

This endpoint retrieves a list of all available job titles.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-titles"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"f8f93f6e-0c88-485d-bf0a-c533578fc461","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-titles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 29,\n \"name\": \"Accountant\",\n \"object_type\": \"job-title\"\n },\n {\n \"id\": 21,\n \"name\": \"Human Resources Manager\",\n \"object_type\": \"job-title\"\n }\n ]\n}"}],"_postman_id":"6626b153-e7fe-4a73-b90f-4c2a6b433327"},{"name":"Create a job title","id":"35b2c197-6086-4711-b067-dbcd01238028","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Maximum character limit: 255 characters. The name must be unique.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-titles","description":"

API endpoint to create a new job title.

\n\n

This endpoint facilitates the creation of a new job title. You should provide the name for the current job title which should be unique.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g Sales Manager
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-titles"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"c1037ef1-3df7-4cbc-a32b-6f12274979ce","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"job-title-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-titles"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 29,\n \"name\": \"Accountant\",\n \"object_type\": \"job-title\"\n }\n}"},{"id":"baf9ae06-d045-4855-8c10-2d2c23475275","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"job-title-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-titles"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"35b2c197-6086-4711-b067-dbcd01238028"},{"name":"Get a job title","id":"f273d9dc-e13f-46ab-970e-702dff2a9951","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-titles/:objectId","description":"

API endpoint to fetch the information for a job title.

\n\n

This endpoint retrieves the specified job title from the system's 'job-titles'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-titles",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a3bc6e59-37fb-4a1c-8a69-84f17b830dff","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"39651399-9042-41bc-abfa-a0485c90701b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 29,\n \"name\": \"Accountant\",\n \"object_type\": \"job-title\"\n }\n}"},{"id":"f650cc47-6c11-46ae-ba4d-99e695457da5","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"f273d9dc-e13f-46ab-970e-702dff2a9951"},{"name":"Update a job title","id":"372cca97-bc1c-4b16-96b2-68837913b6d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"// Maximum character limit: 255 characters. The name must be unique.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/job-titles/:objectId","description":"

API endpoint to update the specified job title.

\n\n

This endpoint updates the specified job title. You should provide the name of the current job title which should be unique.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 255 characters. Name must be unique.e.g Sales Manager
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-titles",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"e299e55d-6cfb-4754-9de9-a2e709098ebe","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"45081a12-7c7d-43f8-b84f-cb8e37c115e2","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"job-title-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 29,\n \"name\": \"Accountant\",\n \"object_type\": \"job-title\"\n }\n}"},{"id":"3675970f-43a4-4855-b3a8-ae3f79af9185","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"job-title-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"c67f7aa3-6baf-4add-a487-48fd03019eea","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"job-title-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"372cca97-bc1c-4b16-96b2-68837913b6d8"},{"name":"Delete a job title","id":"0562f2ca-cb48-4b4a-b64d-5f8fb1ce0195","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/job-titles/:objectId","description":"

API endpoint to delete the specified job title.

\n\n

This endpoint deletes the specified job title. However, if the job title is associated with an active job position record, the deletion cannot proceed.

\n

Furthermore, when a job title record is deleted, any associated benefits, performance reviews, holidays and tasks, linked to the job title are updated accordingly, removing the job title attribute from these records.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["job-titles",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"960967f7-3c44-4d60-895f-73f0ae77f10b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"47bf92d8-68c1-49ee-b207-3bf60e5d1fdd","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"4c85cdd9-5186-416d-b095-4f8df0f60689","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/job-titles/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["job-titles",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"0562f2ca-cb48-4b4a-b64d-5f8fb1ce0195"}],"id":"fde0d750-eb77-4d2f-bf8b-e8af3924bcb6","_postman_id":"fde0d750-eb77-4d2f-bf8b-e8af3924bcb6","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Benefit","item":[{"name":"Get all benefits","id":"228f8389-67b5-4cd7-a3a0-92f8f20c3ab0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefits?filter=","description":"

API endpoint to get all available benefits.

\n\n

This endpoint retrieves comprehensive information for all benefits which are available within the system. Each benefit includes general information, as well as category-specific details and prerequisites if the benefit is not required for everyone (required for specific department, division, location, job title, employment status, or employee).

\n

This endpoint offers the flexibility to use filters for retrieving specific data based on your requirements. These filters could include locations, divisions, departments, job titles, employment statuses, and individual employees. To retrieve the valid benefit filters (and therefore the Ids you need), you should access the \"Get all benefit filters\" endpoint.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefits"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Filters for the benefits with their Ids (integer), ('location' => [],'department' => [],'division' => [],'job_title' => [],'emp_state' => [],'employee' => []). Example: location=36;emp_state=1,2,3,5;employee=1;

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"506a1f1d-a696-405e-8b42-5c4b7b012979","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"name\": \"benefit-name\",\n \"description\": null,\n \"cost\": null,\n \"cost_currency\": \"USD\",\n \"cost_period\": null,\n \"required_for_all\": false,\n \"benefit_category_id\": 1,\n \"created_at\": \"2023-11-16 07:48:58\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"start_date\": \"2023-01-02\",\n \"end_date\": \"2023-12-30\",\n \"benefit_category\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\"\n },\n \"benefit_required_for\": [\n {\n \"id\": 1,\n \"benefit_id\": 2,\n \"object_id\": 36,\n \"required_for_type\": \"location\",\n \"created_at\": \"2024-02-21 09:37:37\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"object_name\": \"Athens\",\n \"employee_custom_field\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\"\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"228f8389-67b5-4cd7-a3a0-92f8f20c3ab0"},{"name":"Create a benefit","id":"311d6912-261b-411e-be3d-d746bc22b640","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field. Maximum character limit:191 characters.\n \"start_date\": \"\", // Required field. The start date must be formatted as 'YYYY-MM-DD'.\n \"benefit_category_id\": \"\", // Nullable ield. Unique identifier of benefit categories.\n \"end_date\": \"\", // Nullable field. The end date must be formatted as 'YYYY-MM-DD'and be after or equal of 'start_date'.\n \"cost\": \"\", // Required when cost_period is available. The field can have a maximum of 2 decimal places.\n \"cost_period\": \"\",// Required when cost is available.The field can have certain specific values [Once off, hour, day, week, month, quarter, year]\n \"description\": \"\", // Nullable field. Maximum character limit:1000 characters.\n \"required_for_all\": \"\", //Required without 'benefit_required_for'\n \"benefit_required_for\": { // Required when 'required_for_all' is FALSE. Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) with integer values (of Ids). At least one array within the object must contain at least one value.\n \"location\": [\n \"\", // Unique identifier from locations.\n \"\" // Unique identifier from locations.\n ],\n \"division\": [\n \"\", // Unique identifier from divisions.\n \"\" // Unique identifier from divisions.\n ],\n \"department\": [\n \"\", // Unique identifier from departments.\n \"\" // Unique identifier from departments.\n ],\n \"job_title\": [\n \"\", // Unique identifier from job titles.\n \"\" // Unique identifier from job titles.\n ],\n \"emp_state\": [\n \"\", // Unique identifier from employment status.\n \"\" // Unique identifier from employment status.\n ],\n \"employee\": [\n \"\", // Unique identifier from employees.\n \"\" // Unique identifier from employees.\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefits","description":"

API endpoint to create a new benefit.

\n\n

This endpoint facilitates the creation of a new benefit. The request body should include the following parameters: the benefit's name, a start and an end date for the benefit, the benefit's specific category, its cost and cost period, a description, and a required_for_all flag indicating whether the benefit is mandatory for everyone.

\n

In cases where required_for_all is set to FALSE, an additional parameter benefit_required_for must be included. This parameter delineates the specific department, division, location, job title, employment status, or employee to whom the benefit applies.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g
Health Insurance
start_datedatetrueThe start date must be formatted as 'YYYY-MM-DD'.e.g 2024-03-01
benefit_category_idintegerfalseUnique identifier from benefit categoriese.g 1
end_datedatefalseThe end date must be formatted as 'YYYY-MM-DD' and be after or equal the 'start_date'.e.g 2024-03-05
costnumberRequired when cost_period is available.The field can have a maximum of 2 decimal places.e.g 965.32
cost_periodstringtrueRequired when cost is available.The field can have certain specific values [Once off, hour, day, week, month, quarter, year]e.g week
descriptionstringfalseMaximum character limit:1000 characters.e.g
Health insurance pays most medical and surgical expenses and preventative care costs in return for monthly premiums.
required_for_allbooleanRequired without 'benefit_required_for'e.g true
benefit_required_forobjectRequired when 'required_for_all' is FALSE.Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) with integer values (of Ids). At least one array within the object must contain at least one value.benefit_required_for':{\"location\":[35],\"division\":[16],\"department\":[],\"job_title\":[],\"emp_state\":[],\"employee\":[]}'
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefits"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"047a8b08-f558-43f3-a529-8490f64d6166","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"start_date\": \"\",\n \"benefit_category_id\": \"\",\n \"end_date\": \"\",\n \"cost\": \"\",\n \"cost_period\": \"\",\n \"description\": \"\",\n \"required_for_all\": \"\",\n \"benefit_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefits"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"benefit-name\",\n \"description\": null,\n \"cost\": null,\n \"cost_currency\": \"USD\",\n \"cost_period\": null,\n \"required_for_all\": false,\n \"benefit_category_id\": 1,\n \"created_at\": \"2023-11-16 07:48:58\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"start_date\": \"2023-01-02\",\n \"end_date\": \"2023-12-30\",\n \"benefit_category\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\"\n },\n \"benefit_required_for\": [\n {\n \"id\": 1,\n \"benefit_id\": 2,\n \"object_id\": 36,\n \"required_for_type\": \"location\",\n \"created_at\": \"2024-02-21 09:37:37\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"object_name\": \"Athens\",\n \"employee_custom_field\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\"\n }\n }\n ]\n }\n}"},{"id":"f337a933-31fe-4a39-ab2e-295f5f32094b","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"start_date\": \"\",\n \"benefit_category_id\": \"\",\n \"end_date\": \"\",\n \"cost\": \"\",\n \"cost_period\": \"\",\n \"description\": \"\",\n \"required_for_all\": \"\",\n \"benefit_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefits"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"311d6912-261b-411e-be3d-d746bc22b640"},{"name":"Get a benefit","id":"f1dcb702-3c47-42f1-b93a-4291af455bee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefits/:objectId","description":"

API endpoint to fetch the information for a benefit.

\n\n

This endpoint retrieves comprehensive information for a specified benefit.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefits",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"ec7db6bc-55d5-4480-8040-5a1c57f32db2","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"1a6154b0-0f38-478b-ae89-fc94a3ec216c","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"benefit-name\",\n \"description\": null,\n \"cost\": null,\n \"cost_currency\": \"USD\",\n \"cost_period\": null,\n \"required_for_all\": false,\n \"benefit_category_id\": 1,\n \"created_at\": \"2023-11-16 07:48:58\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"start_date\": \"2023-01-02\",\n \"end_date\": \"2023-12-30\",\n \"benefit_category\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\"\n },\n \"benefit_required_for\": [\n {\n \"id\": 1,\n \"benefit_id\": 2,\n \"object_id\": 36,\n \"required_for_type\": \"location\",\n \"created_at\": \"2024-02-21 09:37:37\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"object_name\": \"Athens\",\n \"employee_custom_field\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\"\n }\n }\n ]\n }\n}"},{"id":"5f9149e9-91e6-425c-9736-4758539f4a57","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"f1dcb702-3c47-42f1-b93a-4291af455bee"},{"name":"Update a benefit","id":"12654cf1-af01-4a7b-b99d-ae409c464c3e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field. Maximum character limit:191 characters.\n \"start_date\": \"\", // Required field. The start date must be formatted as 'YYYY-MM-DD'.\n \"benefit_category_id\": \"\", // Nullable field. Unique identifier from benefit categories.\n \"end_date\": \"\", // Required field. The end date must be formatted as 'YYYY-MM-DD' and be after or equal the 'start_date'.\n \"cost\": \"\", // Required when cost_period is available. The field can have a maximum of 2 decimal places.\n \"cost_period\": \"\",// Required when cost or cost_currency is available.The field can have certain specific values [Once off, hour, day, week, month, quarter, year]\n \"description\": \"\", // Nullable field. Maximum character limit:1000 characters.\n \"required_for_all\": \"\", //Required without 'benefit_required_for'\n \"benefit_required_for\": { // Required when 'required_for_all' is FALSE. Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) with integer values (of Ids). At least one array within the object must contain at least one value.\n \"location\": [\n \"\", // Unique identifier from locations.\n \"\" // Unique identifier from locations.\n ],\n \"division\": [\n \"\", // Unique identifier from divisions.\n \"\" // Unique identifier from divisions.\n ],\n \"department\": [\n \"\", // Unique identifier from departments.\n \"\" // Unique identifier from departments.\n ],\n \"job_title\": [\n \"\", // Unique identifier from job titles.\n \"\" // Unique identifier from job titles.\n ],\n \"emp_state\": [\n \"\", // Unique identifier from employment status.\n \"\" // Unique identifier from employment status.\n ],\n \"employee\": [\n \"\", // Unique identifier from employees.\n \"\" // Unique identifier from employees.\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefits/:objectId","description":"

API endpoint to update the specified benefit.

\n\n

This endpoint updates the specified benefit. The request body should include the following parameters: the benefit's name, a start and end date for the benefit, the benefit's specific category, its cost and cost period, a description, and a required_for_all flag indicating whether the benefit is mandatory for everyone.

\n

In cases where required_for_all is set to FALSE, an additional parameter benefit_required_for must be included. This parameter delineates the specific department, division, location, job title, employment status, or employee to whom the benefit applies.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g
Health Insurance
start_datedatetrueThe start date must be formatted as 'YYYY-MM-DD'.e.g
2024-03-01
benefit_category_idintegerfalseUnique identifier from benefit categoriese.g
end_datedatefalseThe end date must be formatted as 'YYYY-MM-DD' and be after or equal the 'start_date'.e.g
2024-03-05
costnumberRequired when cost_period is available.The field can have a maximum of 2 decimal places.e.g 965.32
cost_periodstringrequiredRequired when cost is available.The field can have certain specific values [Once off, hour, day, week, month, quarter, year]e.g week
descriptionstringfalseMaximum character limit:1000 characters.e.g
Health insurance pays most medical and surgical expenses and preventative care costs in return for monthly premiums.
required_for_allbooleanRequired without 'benefit_required_for'e.g
true
benefit_required_forobjectRequired when 'required_for_all' is FALSE.Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) with integer values (of Ids). At least one array within the object must contain at least one value.benefit_required_for':{\"location\":[\"35\"],\"division\":[\"16\"],\"department\":[],\"job_title\":[],\"emp_state\":[],\"employee\":[]}'
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefits",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"024e0e15-c6cc-4a22-8c47-1a2de599f909","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"4ec14f5d-31c9-43f5-a132-47d960db9617","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"start_date\": \"\",\n \"benefit_category_id\": \"\",\n \"end_date\": \"\",\n \"cost\": \"\",\n \"cost_period\": \"\",\n \"description\": \"\",\n \"required_for_all\": \"\",\n \"benefit_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"name\": \"benefit-name\",\n \"description\": null,\n \"cost\": null,\n \"cost_currency\": \"USD\",\n \"cost_period\": null,\n \"required_for_all\": false,\n \"benefit_category_id\": 1,\n \"created_at\": \"2023-11-16 07:48:58\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"start_date\": \"2023-01-02\",\n \"end_date\": \"2023-12-30\",\n \"benefit_category\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\"\n },\n \"benefit_required_for\": [\n {\n \"id\": 1,\n \"benefit_id\": 2,\n \"object_id\": 36,\n \"required_for_type\": \"location\",\n \"created_at\": \"2024-02-21 09:37:37\",\n \"updated_at\": \"2024-02-21 09:37:37\",\n \"deleted_at\": null,\n \"object_name\": \"Athens\",\n \"employee_custom_field\": {\n \"id\": 36,\n \"name\": \"Athens\",\n \"object_type\": \"location\"\n }\n }\n ]\n }\n}"},{"id":"c178baf5-5022-4cb5-8508-dc3dbf5a8a54","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"start_date\": \"\",\n \"benefit_category_id\": \"\",\n \"end_date\": \"\",\n \"cost\": \"\",\n \"cost_period\": \"\",\n \"description\": \"\",\n \"required_for_all\": \"\",\n \"benefit_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"460eb300-44e4-4e3f-be35-7a6230221446","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"start_date\": \"\",\n \"benefit_category_id\": \"\",\n \"end_date\": \"\",\n \"cost\": \"\",\n \"cost_period\": \"\",\n \"description\": \"\",\n \"required_for_all\": \"\",\n \"benefit_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"12654cf1-af01-4a7b-b99d-ae409c464c3e"},{"name":"Delete a benefit","id":"e2e300a5-0953-4578-97ce-0cdebcfb7786","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefits/:objectId","description":"

API endpoint to delete the specified benefit.

\n\n

This endpoint facilitates the deletion of the specified benefit.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefits",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"dab64abc-cd0f-4e3c-a151-fb743347f56b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"f8342962-9a5c-4bf7-aac4-772de903b565","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"b63113e9-1ec7-49ec-8681-86412eb75e0b","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefits/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefits",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"e2e300a5-0953-4578-97ce-0cdebcfb7786"},{"name":"Get all benefit filters","id":"7ae15e7f-674f-463c-ae36-a264a770c0da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefits/filters","description":"

API endpoint to get the available filters for the benefits.

\n\n

This endpoint allows you to fetch a list of valid filters for the benefits.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefits","filters"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"6f94e6b3-bd67-4b0d-b598-c84d5642c84f","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefits/filters"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"departments\": [\n {\n \"id\": 6,\n \"name\": \"Administration & Operations\"\n },\n {\n \"id\": 7,\n \"name\": \"Research & Development\"\n },\n {\n \"id\": 8,\n \"name\": \"Marketing & Sales\"\n },\n {\n \"id\": 9,\n \"name\": \"Human Resources\"\n }\n ],\n \"divisions\": [\n {\n \"id\": 12,\n \"name\": \"North America\"\n },\n {\n \"id\": 13,\n \"name\": \"Europe\"\n }\n ],\n \"locations\": [\n {\n \"id\": 33,\n \"name\": \"New York\"\n },\n {\n \"id\": 34,\n \"name\": \"California\"\n },\n {\n \"id\": 35,\n \"name\": \"London\"\n },\n {\n \"id\": 36,\n \"name\": \"Athens\"\n }\n ],\n \"job_titles\": [\n {\n \"id\": 18,\n \"name\": \"Chief Executive Officer\"\n },\n {\n \"id\": 21,\n \"name\": \"Human Resources Manager\"\n },\n {\n \"id\": 22,\n \"name\": \"IT Manager\"\n },\n {\n \"id\": 23,\n \"name\": \"Marketing Manager\"\n },\n {\n \"id\": 24,\n \"name\": \"Sales Manager\"\n }\n ],\n \"emp_state\": [\n {\n \"id\": 1,\n \"name\": \"Full-Time\"\n },\n {\n \"id\": 2,\n \"name\": \"Part-Time\"\n }\n ],\n \"employees\": [\n {\n \"id\": 15,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/15_1700059591.jpg?Expires=1708600410&Signature=ZxqghQxcKsjMJSBLgzEJOxdgMFQ9Tg1JsQ9fmGbZRA698CoJ67DbIK9r0jW2zO~LpwvWEL9hbR8aBeMmHem6Eqhc3NHj9suRJkYrOZr9xYJwiIC~ipODzajtHRFPzL46Y1vr~Nmcv814m6XJ5v9yoOfXl6Wrq5fd8iMJMd0Z0vGQimLH~PypvDosHuOu~il~8p7tcKCWeYITRDX6plPjmkTKAlvrp0rpppjiXc5GgjVysCB~JhEHmnMAzPLKggKOh0613AGxDPGQzbv1RhiX7iR1~0wFZRfjEyQOoUwAZAKkS6FlVimRw7Olc78G6wD4cLBx1Bn4DDT6SYnhzH8LqQ__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"first_name\": \"Doe\",\n \"last_name\": \"John\",\n \"email\": \"john.doe@example.com\"\n }\n ]\n }\n}"}],"_postman_id":"7ae15e7f-674f-463c-ae36-a264a770c0da"}],"id":"9a84ac80-04f2-4c54-a413-fa4587458a6b","_postman_id":"9a84ac80-04f2-4c54-a413-fa4587458a6b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Benefit (Categories)","item":[{"name":"Get all benefit categories","id":"dff603fa-31e5-4288-a452-3799b334e34e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefit-categories","description":"

API endpoint to get all available benefit categories.

\n\n

This endpoint retrieves comprehensive info about the benefit categories.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefit-categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"68f29db8-c7ea-4bb2-8275-fb29f7f9725b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefit-categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"benefit-category-1\",\n \"created_at\": \"2024-02-21 08:13:02\",\n \"updated_at\": \"2024-02-21 08:13:02\",\n \"deleted_at\": null\n }\n ]\n}"}],"_postman_id":"dff603fa-31e5-4288-a452-3799b334e34e"},{"name":"Create a benefit category","id":"a822d72d-d322-4376-b2e2-be3c0e649f08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefit-categories","description":"

API endpoint to create a new benefit category.

\n\n

This endpoint facilitates the creation of a new benefit category. You should provide the name of the current category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g. General
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefit-categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"3108f78d-d473-4bff-8b27-0cde1ebe0bd5","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"benefit-category-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefit-categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\",\n \"created_at\": \"2024-02-21 08:13:02\",\n \"updated_at\": \"2024-02-21 08:13:02\",\n \"deleted_at\": null\n }\n}"},{"id":"f9a2df05-db3e-41dd-93b7-b9dcddc7c9e6","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"benefit-category-name\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefit-categories"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"a822d72d-d322-4376-b2e2-be3c0e649f08"},{"name":"Get a benefit category","id":"9ac5c82d-3390-4870-995c-e7cead07a7a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","description":"

API endpoint to fetch information for a benefit category.

\n\n

This endpoint retrieves the specified benefit category.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefit-categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"10f8f826-9493-4afa-be81-6f7c5c2fadf5","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"54f98adb-5ce0-4b3c-b4d1-1f04b81de749","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\",\n \"created_at\": \"2024-02-21 08:13:02\",\n \"updated_at\": \"2024-02-21 08:13:02\",\n \"deleted_at\": null\n }\n}"},{"id":"1b011213-6048-4a79-8446-d962a0891c05","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"9ac5c82d-3390-4870-995c-e7cead07a7a0"},{"name":"Update a benefit category","id":"88073194-9944-40fd-839c-0a45f5609e0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","description":"

API endpoint to update a benefit category.

\n

This endpoint updates the specific benefit category. You should provide the name of the current category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g. General
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefit-categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b42d82ac-d472-41b5-9f4c-f133a50dc6fe","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"baac944e-49f9-484f-98b5-6c9d420c0598","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"benefit-category-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"benefit-category-1\",\n \"created_at\": \"2024-02-21 08:13:02\",\n \"updated_at\": \"2024-02-21 08:13:02\",\n \"deleted_at\": null\n }\n}"},{"id":"f0232978-92c1-4b5d-a472-c933b0fc9b24","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"benefit-category-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"e09d9587-28e8-472d-8feb-750518647a46","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"benefit-category-name\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"88073194-9944-40fd-839c-0a45f5609e0b"},{"name":"Delete a benefit category","id":"390c5269-6284-4043-917d-5b404f488a6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","description":"

API endpoint to delete a benefit category.

\n\n

This endpoint facilitates the deletion of the specified benefit. Upon deletion, all benefits associated with the specified category will be moved to the general category (uncategorized).

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["benefit-categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"ee89a456-ed4b-429d-83d8-8e0f81c966d3","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c9b26e8d-6933-4dc5-933c-c5b71e7f3201","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"cfa72b41-2b2d-4ca4-81f7-8dac373fa372","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/benefit-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["benefit-categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"390c5269-6284-4043-917d-5b404f488a6f"}],"id":"48c00e4e-0863-45e2-b1e6-84a4e48d8bea","_postman_id":"48c00e4e-0863-45e2-b1e6-84a4e48d8bea","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Holidays","item":[{"name":"Get all holidays","id":"b982bd62-450c-42ea-830d-baad9cdbc681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/holidays?year=","description":"

API endpoint to retrieve all the available holidays.

\n\n

This endpoint retrieves comprehensive information for all holidays which are available within the system. Each holiday includes general information, as well as category-specific details and prerequisites if the holiday is not required for everyone (required for specific department, division, location, job title, employment status, or employee).

\n

There is a query parameter in the endpoint that specifies the year for which we want to retrieve the holidays. Valid years for holidays can be obtained from the 'get holiday years' endpoint. If this parameter is not provided, the endpoint will default to returning holidays for the current year.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["holidays"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

The year of the holidays that occur. E.g. 2024

\n","type":"text/plain"},"key":"year","value":""}],"variable":[]}},"response":[{"id":"257a0577-bbc8-4165-98a6-4e6034bbcd47","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/holidays"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 13,\n \"name\": \"New Year's Day\",\n \"holiday_date\": \"2024-01-01\",\n \"required_for_all\": false,\n \"created_at\": \"2023-11-15 13:56:11\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"holiday_required_for\": [\n {\n \"id\": 3,\n \"holiday_id\": 13,\n \"object_id\": 13,\n \"required_for_type\": \"division\",\n \"created_at\": \"2024-02-20 11:25:56\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"object_name\": \"Europe\"\n }\n ]\n },\n {\n \"id\": 14,\n \"name\": \"Epiphany\",\n \"holiday_date\": \"2024-01-06\",\n \"required_for_all\": true,\n \"created_at\": \"2023-11-15 13:56:11\",\n \"updated_at\": \"2023-11-15 13:56:11\",\n \"deleted_at\": null,\n \"holiday_required_for\": []\n }\n ]\n}"}],"_postman_id":"b982bd62-450c-42ea-830d-baad9cdbc681"},{"name":"Create a holiday","id":"b837d318-676b-4647-87a0-369c0870206a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field. Maximum character limit:191 characters.\n \"required_for_all\": \"\", // Required without 'holiday_required_for'\n \"holiday_date\": \"\", // The holiday date must be formatted as 'YYYY-MM-DD'.\n \"holiday_required_for\": { // Required when the 'required_for_all' is FALSE. Object with PROPERTIES: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) that contains the Id's of the specified field. At least one array within the object must contain at least one value.\n \"location\": [\n \"\", // Unique identifier from locations.\n \"\" // Unique identifier from locations.\n ],\n \"division\": [\n \"\", // Unique identifier from divisions.\n \"\" // Unique identifier from divisions.\n ],\n \"department\": [\n \"\", // Unique identifier from departments.\n \"\" // Unique identifier from departments.\n ],\n \"job_title\": [\n \"\", // Unique identifier from job titles.\n \"\" // Unique identifier from job titles.\n ],\n \"emp_state\": [\n \"\", // Unique identifier from employment status.\n \"\" // Unique identifier from employment status.\n ],\n \"employee\": [\n \"\", // Unique identifier from employees.\n \"\" // Unique identifier from employees.\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/holidays","description":"

API endpoint to create a new holiday.

\n\n

This endpoint facilitates the creation of a new holiday. The request body should include the following parameters: the holiday's name, the holiday date, and a required_for_all flag indicating whether the holiday is mandatory for everyone.

\n

In cases where required_for_all is set to FALSE, an additional parameter holiday_required_for must be included. This parameter delineates the specific department, division, location, job title, employment status, or employee to whom the holiday applies.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g.
Christmas Day
holiday_datedatetrueThe holiday date must be formatted as 'YYYY-MM-DD'.e.g. 2024-03-01
required_for_allbooleanRequired without 'holiday_required_for'e.g. true
holiday_required_forobjectRequired when 'required_for_all' is FALSE.Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) with integer values (of Ids). At least one array within the object must contain at least one value.e.g.
'holiday_required_for':{\"location\":[35],\"division\":[16],\"department\":[],\"job_title\":[],\"emp_state\":[],\"employee\":[]}'
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["holidays"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"ed964396-c8b9-471b-81dc-8d975bf390a5","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"required_for_all\": \"\",\n \"holiday_date\": \"\",\n \"holiday_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/holidays"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 13,\n \"name\": \"New Year's Day\",\n \"holiday_date\": \"2024-01-01\",\n \"required_for_all\": false,\n \"created_at\": \"2023-11-15 13:56:11\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"holiday_required_for\": [\n {\n \"id\": 3,\n \"holiday_id\": 13,\n \"object_id\": 13,\n \"required_for_type\": \"division\",\n \"created_at\": \"2024-02-20 11:25:56\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"object_name\": \"Europe\"\n }\n ]\n }\n}"},{"id":"e776b74a-b0f7-4e9d-92ac-8a38b81665f9","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"required_for_all\": \"\",\n \"holiday_date\": \"\",\n \"holiday_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/holidays"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"b837d318-676b-4647-87a0-369c0870206a"},{"name":"Get a holiday","id":"67da12cd-1e97-47cd-a9a6-23603d37aa81","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/holidays/:objectId","description":"

API endpoint to fetch information about a specified holiday.

\n\n

This endpoint retrieves information about the specified holiday.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["holidays",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"2e1fad27-c5eb-4de2-8223-01f2b0c2346a","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"d107343f-8f49-47a7-b8a1-26dff9a509c5","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 13,\n \"name\": \"New Year's Day\",\n \"holiday_date\": \"2024-01-01\",\n \"required_for_all\": false,\n \"created_at\": \"2023-11-15 13:56:11\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"holiday_required_for\": [\n {\n \"id\": 3,\n \"holiday_id\": 13,\n \"object_id\": 13,\n \"required_for_type\": \"division\",\n \"created_at\": \"2024-02-20 11:25:56\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"object_name\": \"Europe\"\n }\n ]\n }\n}"},{"id":"f54d6493-8bfb-40bb-be0c-34dcb3edd66b","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"67da12cd-1e97-47cd-a9a6-23603d37aa81"},{"name":"Update a holiday","id":"01e85519-8c14-42c5-b073-7f5fa46aa5e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field. Maximum character limit:191 characters.\n \"required_for_all\": \"\", // Required without 'holiday_required_for'\n \"holiday_date\": \"\", // The holiday date must be formatted as 'YYYY-MM-DD'.\n \"holiday_required_for\": { // Required when the 'required_for_all' is FALSE. Object with PROPERTIES: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) that contains the Id's of the specified field. At least one array within the object must contain at least one value.\n \"location\": [\n \"\", // Unique identifier from locations.\n \"\" // Unique identifier from locations.\n ],\n \"division\": [\n \"\", // Unique identifier from divisions.\n \"\" // Unique identifier from divisions.\n ],\n \"department\": [\n \"\", // Unique identifier from departments.\n \"\" // Unique identifier from departments.\n ],\n \"job_title\": [\n \"\", // Unique identifier from job titles.\n \"\" // Unique identifier from job titles.\n ],\n \"emp_state\": [\n \"\", // Unique identifier from employment status.\n \"\" // Unique identifier from employment status.\n ],\n \"employee\": [\n \"\", // Unique identifier from employees.\n \"\" // Unique identifier from employees.\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/holidays/:objectId","description":"

API endpoint to update the specified holiday.

\n\n

This endpoint updates the specified holiday. The request body should include the following parameters: the holiday's name, the holiday date, and a required_for_all flag indicating whether the holiday is mandatory for everyone.

\n

In cases where required_for_all is set to FALSE, an additional parameter holiday_required_for must be included. This parameter delineates the specific department, division, location, job title, employment status, or employee to whom the holiday applies.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g
Christmas Day
holiday_datedatetrueThe holiday date must be formatted as 'YYYY-MM-DD'.e.g 2024-03-01
required_for_allbooleanRequired without 'holiday_required_for'e.g true
holiday_required_forobjectRequired when 'required_for_all' is FALSE.Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array), employee (array) with integer values (of Ids). At least one array within the object must contain at least one value.benefit_required_for':{\"location\":[35],\"division\":[16],\"department\":[],\"job_title\":[],\"emp_state\":[],\"employee\":[]}'
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["holidays",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"e783e820-5e23-4e6e-a8c3-023f48f1e72f","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"af71c9c3-1419-4015-ad5d-e31e96349003","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"required_for_all\": \"\",\n \"holiday_date\": \"\",\n \"holiday_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 13,\n \"name\": \"New Year's Day\",\n \"holiday_date\": \"2024-01-01\",\n \"required_for_all\": false,\n \"created_at\": \"2023-11-15 13:56:11\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"holiday_required_for\": [\n {\n \"id\": 3,\n \"holiday_id\": 13,\n \"object_id\": 13,\n \"required_for_type\": \"division\",\n \"created_at\": \"2024-02-20 11:25:56\",\n \"updated_at\": \"2024-02-20 11:25:56\",\n \"deleted_at\": null,\n \"object_name\": \"Europe\"\n }\n ]\n }\n}"},{"id":"6c5e141c-ba4d-495f-bde7-bd11ca9397ea","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"required_for_all\": \"\",\n \"holiday_date\": \"\",\n \"holiday_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"e709b93f-80e2-4006-ab15-05f771d6e169","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"required_for_all\": \"\",\n \"holiday_date\": \"\",\n \"holiday_required_for\": {\n \"location\": [\n \"\",\n \"\"\n ],\n \"division\": [\n \"\",\n \"\"\n ],\n \"department\": [\n \"\",\n \"\"\n ],\n \"job_title\": [\n \"\",\n \"\"\n ],\n \"emp_state\": [\n \"\",\n \"\"\n ],\n \"employee\": [\n \"\",\n \"\"\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"01e85519-8c14-42c5-b073-7f5fa46aa5e2"},{"name":"Delete a holiday","id":"cb0e8949-2621-4585-a207-606e66c0a9b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/holidays/:objectId","description":"

API endpoint to delete the specified holiday.

\n\n

This endpoint facilitates the deletion of the specified holiday.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["holidays",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b33f9748-cdb0-42a1-9ca7-ccec497b5758","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"1c81c672-5d84-496a-9580-8d1905396e1d","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"ddf07271-70db-40a0-85e2-725f9babfc51","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/holidays/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["holidays",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"cb0e8949-2621-4585-a207-606e66c0a9b0"},{"name":"Get holiday years","id":"fd12071f-cadc-4fd8-ba89-e67827342ec2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/holidays/years","description":"

API endpoint to get each available year of holidays.

\n\n

This endpoint returns the years for which holidays are available in our system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["holidays","years"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"b731d0f6-cd04-4d45-ad89-d58b61c06907","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/holidays/years"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"type\": \"success\",\n \"data\": [\n 2023,\n 2024\n ]\n}"}],"_postman_id":"fd12071f-cadc-4fd8-ba89-e67827342ec2"}],"id":"64f63a5c-5b00-43b8-9eac-d9f83abf2873","_postman_id":"64f63a5c-5b00-43b8-9eac-d9f83abf2873","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Time off (Types)","item":[{"name":"Get time off types","id":"e485e651-e54b-4c4f-9059-1214c5957be7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/time-off-types","description":"

API Endpoint to retrieve the available time off types.

\n

This endpoint gets a list of time off types.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["time-off-types"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"86be838e-872d-49a3-b8b8-110aa15d2f6b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/time-off-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\",\n \"budget\": \"5.000\",\n \"period\": \"days\",\n \"paid\": true,\n \"is_default\": true,\n \"created_at\": \"2023-06-15 06:08:13\",\n \"updated_at\": \"2023-06-15 06:08:13\",\n \"deleted_at\": null,\n \"is_disabled\": false\n },\n {\n \"id\": 4,\n \"name\": \"Vacation\",\n \"slug\": \"vacation\",\n \"budget\": \"15.000\",\n \"period\": \"days\",\n \"paid\": true,\n \"is_default\": true,\n \"created_at\": \"2023-06-15 06:08:13\",\n \"updated_at\": \"2023-06-15 06:08:13\",\n \"deleted_at\": null,\n \"is_disabled\": false\n }\n ]\n}"}],"_postman_id":"e485e651-e54b-4c4f-9059-1214c5957be7"},{"name":"Create a time off type","id":"6dca8ffd-4996-425e-b492-04931e57b7bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // (Required) The time off type's name. Maximum character limit: 191 characters.\n \"budget\": \"\", // (Required) Time off Budget with minimum value 0 and maximum value 365. You can't use more than 3 decimal places for budget field..\n \"paid\": \"\", // (Required) If it's 'true' then the time off type days are eligible for payment.\n \"is_disabled\": \"\" // Opt for 'true' to disable the time off type, else 'false' to enable it.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/time-off-types","description":"

API Endpoint to create a new time off type.

\n

This endpoint facilitates the creation of a new time off type. The request body should include the following parameters: the name of the type, the budget for the current type (representing the overall days for the time off), a paid option indicating whether the employee will be paid during this time off, and an option showing whether the time off is enabled or not.

\n

When creating a time off type, time-off budgets are allocated for each employee in our system for the current year and the following one.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueThe time off type's name.e.g. Maternity Leave
budgetnumbertrueTime off Budget with minimum value 0 and maximum value 365. You can't use more than 3 decimal places for budget field.e.g. 30
paidbooleantrueIf it's 'true' then the time off type days are eligible for payment.-
is_disabledbooleanfalseOpt for 'true' to disable the time off type, else 'false' to enable it.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["time-off-types"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"02cb3560-abcb-4296-8050-90bfede5729f","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"budget\": \"\",\n \"paid\": \"\",\n \"is_disabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/time-off-types"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\",\n \"budget\": \"5.000\",\n \"period\": \"days\",\n \"paid\": true,\n \"is_default\": true,\n \"created_at\": \"2023-06-15 06:08:13\",\n \"updated_at\": \"2023-06-15 06:08:13\",\n \"deleted_at\": null,\n \"is_disabled\": false\n }\n}"},{"id":"bf5b4281-3142-485f-a19b-f503c68dff71","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"budget\": \"\",\n \"paid\": \"\",\n \"is_disabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/time-off-types"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"6dca8ffd-4996-425e-b492-04931e57b7bc"},{"name":"Get a time off type","id":"a427f870-586a-44a5-9f1b-ebb438a0a441","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","description":"

API Endpoint to retrieve the specified time off type.

\n

This endpoint retrieves information about the specified time off type.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["time-off-types",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"6f150613-6238-4417-91ea-d2299f76861b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"77a649ea-3350-4714-85ca-3e0691dda440","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\",\n \"budget\": \"5.000\",\n \"period\": \"days\",\n \"paid\": true,\n \"is_default\": true,\n \"created_at\": \"2023-06-15 06:08:13\",\n \"updated_at\": \"2023-06-15 06:08:13\",\n \"deleted_at\": null,\n \"is_disabled\": false\n }\n}"},{"id":"9fe7d2f4-2e1e-477b-9499-7e0249dc5346","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"a427f870-586a-44a5-9f1b-ebb438a0a441"},{"name":"Update a time off type","id":"0b5e83ac-d3fd-4362-92cc-4c90cbb35fb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // (Required) The time off type's name. Maximum character limit: 191 characters.\n \"budget\": \"\", // (Required) Time off Budget with minimum value 0 and maximum value 365. You can't use more than 3 decimal places for budget field\n \"paid\": \"\", // (Required) If it's 'true' then the time off type days are eligible for payment.\n \"is_disabled\": \"\" // Opt for 'true' to disable the time off type, else 'false' to enable it.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","description":"

API Endpoint to update the specified time off type.

\n

This endpoint updates the specified time off type. The request body should include the following parameters: the name of the type, the budget for the current type (representing the overall days for the time off), a paid option indicating whether the employee will be paid during this time off, and an option showing whether the time off is enabled or not.

\n

When updating the time-off type budget, the time-off budgets for each employee in our system for the current year and the following one are adjusted accordingly.

\n

Note: You cannot update the paid option on the pre-existing time-off types within the system.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueThe time off type's name.e.g. Maternity Leave
budgetnumbertrueTime off Budget with minimum value 0 and maximum value 365. You can't use more than 3 decimal places for budget field.e.g. 30
paidbooleantrueIf it's 'true' then the time off type days are eligible for payment.-
is_disabledbooleanfalseOpt for 'true' to disable the time off type, else 'false' to enable it.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["time-off-types",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"4e7f7d4b-3364-4727-8022-a1da58150f8a","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"8b3809ca-2e99-4942-95be-20916598146f","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"budget\": \"\",\n \"paid\": \"\",\n \"is_disabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"slug\": \"sick-leave\",\n \"budget\": \"5.000\",\n \"period\": \"days\",\n \"paid\": true,\n \"is_default\": true,\n \"created_at\": \"2023-06-15 06:08:13\",\n \"updated_at\": \"2023-06-15 06:08:13\",\n \"deleted_at\": null,\n \"is_disabled\": false\n }\n}"},{"id":"03f4c17d-7bae-4cac-b768-054267146421","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"budget\": \"\",\n \"paid\": \"\",\n \"is_disabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"7e16304d-71be-4441-b138-6e0dfdb02d0f","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"budget\": \"\",\n \"paid\": \"\",\n \"is_disabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"0b5e83ac-d3fd-4362-92cc-4c90cbb35fb6"},{"name":"Delete a time off type","id":"f3dae6dd-df9c-4da4-b2ea-97c80670d741","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","description":"

API Endpoint to delete the specified time off type.

\n

This endpoint facilitates the deletion of the specified time off type.

\n

The blocked periods of this time off type also removed.

\n

Note: You cannot delete a time-off type that currently has active at least one time off.

\n

Note: You cannot delete the system's pre-existing time-off types.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["time-off-types",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"26943e8a-ec72-41ab-a980-ffdeae528c1b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"4d5c0dd1-be66-4030-9eca-5f0bd65e1ccc","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"9a6e10dc-580b-46d4-9b10-aaa297ab0749","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/time-off-types/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["time-off-types",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"f3dae6dd-df9c-4da4-b2ea-97c80670d741"}],"id":"3ce4b1f0-bb8d-4561-8876-ec76f00b6b1b","_postman_id":"3ce4b1f0-bb8d-4561-8876-ec76f00b6b1b","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Time off (Blocked period)","item":[{"name":"Get time off blocked periods","id":"158f3ab3-0da9-426f-a826-611ec58d0113","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/blocked-time-offs","description":"

API Endpoint to retrieve the list of date ranges that prohibit requesting time off.

\n

This endpoint provides comprehensive information on time off blocked periods. It provides general details about the blocked periods and the time off types affected by this.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["blocked-time-offs"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"cca2484e-0410-4196-b53e-ec8734008a4a","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/blocked-time-offs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 6,\n \"start_date\": \"2023-12-11\",\n \"end_date\": \"2023-12-15\",\n \"is_active\": false,\n \"created_at\": \"2023-12-04 09:22:09\",\n \"updated_at\": \"2023-12-04 10:19:17\",\n \"deleted_at\": null,\n \"is_for_all\": 0,\n \"time_off_types\": [\n {\n \"id\": 1,\n \"name\": \"Sick Leave\",\n \"pivot\": {\n \"timeoff_blocked_date_id\": 6,\n \"timeoff_type_id\": 1\n }\n },\n {\n \"id\": 3,\n \"name\": \"Bereavement\",\n \"pivot\": {\n \"timeoff_blocked_date_id\": 6,\n \"timeoff_type_id\": 3\n }\n }\n ]\n }\n ]\n}"}],"_postman_id":"158f3ab3-0da9-426f-a826-611ec58d0113"},{"name":"Create a time off blocked period","id":"74189047-c354-4de8-b879-bcb08e2f03cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\", // Required field. The start date of blocked time off. The start date must be formatted as 'YYYY-MM-DD'. This date must be from today forth and before the last day of the next year.\n \"end_date\": \"\", // Required field. The end date of blocked time off. The end date must be formatted as 'YYYY-MM-DD'. This date must be after or equal of start date and from the next year's last day and before.\n \"is_active\": \"\", // Required field. Choose 'true' to activate the blocked period for time off, and 'false' to deactivate it.\n \"timeoff_type\": [ // Array of time off type Ids. It contains the time off type IDs for the designated time off period. This must be present and in case this attribute is empty, it applies to all time off types.\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/blocked-time-offs","description":"

API Endpoint to create a new date range for blocked time off.

\n

This endpoint facilitates the creation of a new time off blocked period. This lets you block one or more date ranges from any type of time-off request. The request body should include the following parameters: the start date and end date of the blocked period, the time-off types affected by this period, and an option indicating whether the blocked period is currently active.

\n

Note: If the timeoff_type attribute has an empty array, it indicates that the time off blocked period will be applicable for all time off types.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
start_datedatetrueThe start date of blocked time off. The start date must be formatted as 'YYYY-MM-DD'. This date must be from today forth and before the last day of the next year.e.g. 2024-03-01
end_datedatetrueThe end date of blocked time off. The end date must be formatted as 'YYYY-MM-DD'. This date must be after start date and from the next year's last day and before.e.g. 2024-03-10
is_activebooleantrueChoose 'true' to activate the blocked period for time off, and 'false' to deactivate it.-
timeoff_typearraytrueArray of time off type Ids. It contains the time off type IDs for the designated time off period. This must be present and in case this attribute is empty, it applies to all time off types.e.g. [1,2,3,4]
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["blocked-time-offs"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"d54c6cdb-d4ff-4f1c-8930-f955c66c525a","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"is_active\": \"\",\n \"timeoff_types\": [\n 1,\n 2,\n 3,\n 4\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/blocked-time-offs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 6,\n \"start_date\": \"2023-12-11\",\n \"end_date\": \"2023-12-15\",\n \"is_active\": false,\n \"created_at\": \"2023-12-04 09:22:09\",\n \"updated_at\": \"2023-12-04 10:19:17\",\n \"deleted_at\": null,\n \"is_for_all\": true\n }\n}"},{"id":"21bce099-98a2-4453-ba38-27d7bf68c19d","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"is_active\": \"\",\n \"timeoff_types\": [\n 1,\n 2,\n 3,\n 4\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/blocked-time-offs"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"74189047-c354-4de8-b879-bcb08e2f03cd"},{"name":"Update a time off blocked period","id":"55e963ae-0331-4086-bd7a-972088c3a42c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\", // The start date of blocked time off. The start date must be formatted as 'YYYY-MM-DD'. This date must be from today forth and before the last day of the next year.\n \"end_date\": \"\", // The end date of blocked time off. The end date must be formatted as 'YYYY-MM-DD'. This date must be after start date and from the next year's last day and before.\n \"is_active\": \"\", // Choose 'true' to activate the blocked period for time off, and 'false' to deactivate it.\n \"timeoff_type\": [ // Array of time off type Ids. It contains the time off type IDs for the designated time off period. This must be present and in case this attribute is empty, it applies to all time off types.\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","description":"

API Endpoint to update a block time off date range.

\n

This endpoint updates the specified time off blocked period. The request body should include the following parameters: the start date and end date of the blocked period, the time-off types affected by this period, and an option indicating whether the blocked period is currently active.

\n

Note: If the timeoff_type attribute has an empty array, it indicates that the time off blocked period will be applicable for all time off types.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
start_datedatetrueThe start date of blocked time off. The start date must be formatted as 'YYYY-MM-DD'. This date must be from today forth and before the last day of the next year.e.g. 2024-03-01
end_datedatetrueThe end date of blocked time off. The end date must be formatted as 'YYYY-MM-DD'. This date must be after start date and from the next year's last day and before.e.g. 2024-03-10
is_activebooleantrueChoose 'true' to activate the blocked period for time off, and 'false' to deactivate it.-
timeoff_typearrayfalseArray of time off type Ids. It contains the time off type IDs for the designated time off period. This must be present and in case this attribute is empty, it applies to all time off types.e.g. [1,2,3,4]
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["blocked-time-offs",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"09342828-f6e6-4af7-a96e-4ada9fdc7c03","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"88bc0880-6f42-4d54-b1a6-cbb73a70d2f0","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"is_active\": \"\",\n \"timeoff_types\": [\n 1,\n 2,\n 3,\n 4\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["blocked-time-offs",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 6,\n \"start_date\": \"2023-12-11\",\n \"end_date\": \"2023-12-15\",\n \"is_active\": false,\n \"created_at\": \"2023-12-04 09:22:09\",\n \"updated_at\": \"2023-12-04 10:19:17\",\n \"deleted_at\": null,\n \"is_for_all\": true\n }\n}"},{"id":"4a6b5acb-c71b-485f-9d89-daec5127762f","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"is_active\": \"\",\n \"timeoff_types\": [\n 1,\n 2,\n 3,\n 4\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["blocked-time-offs",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"43658ff0-ad39-449a-810e-6c301135626c","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"start_date\": \"\",\n \"end_date\": \"\",\n \"is_active\": \"\",\n \"timeoff_types\": [\n 1,\n 2,\n 3,\n 4\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["blocked-time-offs",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"55e963ae-0331-4086-bd7a-972088c3a42c"},{"name":"Delete a time off blocked period","id":"1b74d3ab-3898-4302-a3af-16f24ee14d88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","description":"

API Endpoint to delete a block time off date range.

\n

This endpoint facilitates the deletion of the specified time off blocked period.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["blocked-time-offs",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a64044c9-ec25-4906-a648-d3b37c203a4b","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"2265d074-f179-455c-a186-72b8b6d1b2fd","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["blocked-time-offs",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"1748b49f-c4c3-4936-93a0-112df9120962","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/blocked-time-offs/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["blocked-time-offs",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"1b74d3ab-3898-4302-a3af-16f24ee14d88"}],"id":"92281ed2-c63b-4040-a1f4-c1429310abb1","_postman_id":"92281ed2-c63b-4040-a1f4-c1429310abb1","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Task Management (Task Categories)","item":[{"name":"Get all task categories","id":"375cd377-9073-46dd-a46a-787b69a7908b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","description":"

API endpoint to get either all the onboarding or offboarding task categories.

\n\n

This endpoint provides comprehensive information on task categories within the system. To retrieve data, you must specify the task type for the endpoint, which can be either 'onboarding' or 'offboarding'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","task-categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"e9e6ed87-cb50-4149-836a-c92731535e9d","description":{"content":"

(Required) The task type (onboarding or offboarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"}]}},"response":[{"id":"e2fd359e-f8fa-4a6d-82f7-146ac8d3fe43","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"task-name\",\n \"task_type_id\": 2,\n \"created_at\": \"2023-11-21 08:20:56\",\n \"updated_at\": \"2024-02-15 08:12:31\",\n \"deleted_at\": null,\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n }\n }\n ]\n}"},{"id":"f7e0f55d-d556-47db-b630-8118637b8b9e","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"375cd377-9073-46dd-a46a-787b69a7908b"},{"name":"Create a task category","id":"e4923e0b-9077-422f-80c3-9b2495e56376","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" //Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","description":"

API endpoint to create a new task category.

\n\n

This endpoint facilitates the creation of a new task category. You should provide the name for the current task category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit:191 characters.e.g General
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","task-categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"087d792c-7d1a-4c11-9537-445c7ed47c86","description":{"content":"

(Required) The task type (onboarding or offboarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"}]}},"response":[{"id":"ce93e67c-4bd0-4fd2-a98f-4b24c76bc9f3","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"task-name\",\n \"task_type_id\": 2,\n \"created_at\": \"2023-11-21 08:20:56\",\n \"updated_at\": \"2024-02-15 08:12:31\",\n \"deleted_at\": null,\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n }\n }\n}"},{"id":"7cd85211-f8f5-48fd-a36e-8cbac1f07b20","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"15de4c1d-3853-41d0-9f8e-1a56db84f838","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"e4923e0b-9077-422f-80c3-9b2495e56376"},{"name":"Get a task category","id":"c81cb33f-23d3-49c5-9982-5ce4711cfae7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","description":"

API endpoint to retrieve information about a specified task category.

\n\n

This endpoint retrieves information about the specified task category.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","task-categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"3c605ff4-0d79-4536-98d7-a5be45dffbb6","description":{"content":"

(Required) The task type (onboarding or offboarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"},{"id":"e481c846-d86c-4846-9364-2cdcadb983b9","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"7e8ed6c6-f8ae-462d-9128-dc5046ae81cb","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"task-name\",\n \"task_type_id\": 2,\n \"created_at\": \"2023-11-21 08:20:56\",\n \"updated_at\": \"2024-02-15 08:12:31\",\n \"deleted_at\": null,\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n }\n }\n}"},{"id":"37635826-dbc3-48ef-9800-d6a5e0c7081d","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"c81cb33f-23d3-49c5-9982-5ce4711cfae7"},{"name":"Update a task category","id":"f30ab340-ae00-4c1a-9ee9-009685da9d19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" //Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","description":"

API endpoint to update the specified task category.

\n\n

This endpoint updates the specified task category. You should provide the name for the current task category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit:191 characters.e.g General
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","task-categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"228eabb9-0f7e-4fba-ac17-667add98870a","description":{"content":"

(Required) The task type (onboarding or offboarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"},{"id":"0404c4dd-daa7-450b-bb0d-5b5bb3b0d0a7","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"dbc28b16-aeea-4be5-9c31-c7d578ba82ed","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"name\": \"task-name\",\n \"task_type_id\": 2,\n \"created_at\": \"2023-11-21 08:20:56\",\n \"updated_at\": \"2024-02-15 08:12:31\",\n \"deleted_at\": null,\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n }\n }\n}"},{"id":"7fbc2409-26cb-463d-b43f-9e12ece6a65c","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"f5ff785c-5b24-457c-8959-049a458d5c97","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"f30ab340-ae00-4c1a-9ee9-009685da9d19"},{"name":"Delete a task category","id":"ed6d355a-4673-4f0c-ab41-6382b99be4b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","description":"

API endpoint to delete the specified task category.

\n\n

This endpoint deletes the specified task category. Upon deletion, all tasks associated with the specified category will be moved to the general category (uncategorized).

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","task-categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"3f0f9053-e0b3-47e9-8aad-8f8c5d87da7a","description":{"content":"

(Required) The task type (onboarding or offboarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"},{"id":"82014def-65f8-4c85-a334-f6e473ca5869","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"39c4f0fc-7c8e-4685-b216-0298645b0de0","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"bec2d40e-8d39-4afd-9e75-ad110e806338","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/task-categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","task-categories",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"ed6d355a-4673-4f0c-ab41-6382b99be4b6"}],"id":"a5f86699-02e4-4ff8-9f36-2e0ac831f9c9","_postman_id":"a5f86699-02e4-4ff8-9f36-2e0ac831f9c9","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Task Management (Tasks)","item":[{"name":"Get all tasks","id":"324d4f46-d32b-43c4-8aff-93b890f00bc0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","description":"

API endpoint to get all either the onboarding or the off-boarding tasks.

\n\n

This endpoint retrieves comprehensive information on tasks that take place within the system. To retrieve data, you must specify the task type for the endpoint, which can be either 'onboarding' or 'offboarding'. There are general info about every provided task as well as the task type and for the prerequisites if the task is not required for everyone (required for specific department, division, location, job title, and employment status).

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","tasks"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"9bcc6dfe-1901-4c48-bfb6-58fdc94ae172","description":{"content":"

(Required) The task type (On-boarding or Off-boarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"}]}},"response":[{"id":"45bf999f-d81e-4c1d-ac62-5408aa4bddcd","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"tasks\": [\n {\n \"id\": 13,\n \"name\": \"task-name\",\n \"description\": null,\n \"task_type_id\": 2,\n \"required_for_all\": false,\n \"due_date_period\": \"Months\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 1,\n \"assignee_id\": null,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:46:12\",\n \"deleted_at\": null,\n \"is_for_hire\": true,\n \"is_for_manager\": false,\n \"asset_id\": null,\n \"course_id\": 128,\n \"task_category_id\": 7,\n \"task_category_name\": \"task-category-name\",\n \"task_assignee_name\": \"Employee\",\n \"asset\": null,\n \"task_required_for\": [\n {\n \"id\": \"1,\",\n \"task_id\": 13,\n \"required_for_type\": \"job_title\",\n \"object_id\": 30,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:44:57\",\n \"deleted_at\": null,\n \"object_name\": \"object-name\",\n \"employee_custom_field\": {\n \"id\": 30,\n \"name\": \"object-name\",\n \"object_type\": \"job-title\"\n }\n }\n ]\n }\n ]\n}"},{"id":"4be69d28-759d-44ac-8526-11119a43c400","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"324d4f46-d32b-43c4-8aff-93b890f00bc0"},{"name":"Create a task","id":"57c988cd-f358-4204-b319-f18f7a760a45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", //Required field. Maximum character limit:191 characters.\n \"due_date_value\": \"\", // Required field. Min:-1 and Max: 3650. If -1 then the task assignments created by this task will not have a deadline date.\n \"required_for_all\": \"\", //Required without 'task_required_for'.\n \"assignee_id\": \"\", // Only required if is_for_hire and is_for_manager are false. Unique identifier of active employee. Indicates that a specific employee is responsible for executing the current task.\n \"is_for_hire\": \"\", // Required only if assignee_id is invalid and is_for_manager is false. Indicates a task that will be assigned to be executed by the hired or terminated employee.\n \"is_for_manager\": \"\", // Required only if assignee_id is invalid and is_for_hire is false. Indicates a task that will be assigned to be executed by the manager of the hired or terminated employee.\n \"task_category_id\": \"\", // Not Required field. Unique identifier of task categories.\n \"description\": \"\", //Not Required field. Maximum character limit:10000 characters.\n \"due_date_period\": \"\", // Required unless Due date value is in -1. Valid values are ['days', 'weeks', 'months']\n \"due_date_schedule\": \"\",// Required unless Due date value is in -1. Valid values are ['before', after']\n \"course_id\": \"\", // Not Required field. Unique identifier of TalentLMS courses.\n \"asset_id\": \"\", // Not Required field. Unique identifier of assets.\n \"task_required_for\": { // Required when the 'required_for_all' is FALSE or 'required_for_all'is not present. Object with PROPERTIES: location (array), division (array), department (array), job_title (array), emp_state (array) that contains the Id's of the specified field. At least one array within the object must contain at least one value.\n \"location\": [\n \"\", // Unique identifier from locations.\n \"\" // Unique identifier from locations.\n ],\n \"division\": [\n \"\", // Unique identifier from divisions.\n \"\" // Unique identifier from divisions.\n ],\n \"department\": [\n \"\", // Unique identifier from departments.\n \"\" // Unique identifier from departments.\n ],\n \"job_title\": [\n \"\", // Unique identifier from job titles.\n \"\" // Unique identifier from job titles.\n ],\n \"emp_state\": [\n \"\", // Unique identifier from employment status.\n \"\" // Unique identifier from employment status.\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","description":"

API endpoint to create a new task.

\n\n

This endpoint facilitates the creation of a new task. The request body should include the task's name, a description, the task's specific category, a due date for the task, a required_for_all flag indicating whether the task is mandatory for everyone, and some additional information specifying who will be assigned the task.

\n

In cases where required_for_all is set to FALSE, an additional parameter task_required_for must be included. This parameter delineates the specific department, division, location, job title, or employment status to which the task applies.

\n

As for who is going to run the task assignment, there are three options

\n
    \n
  1. Assigned to the hired/terminated employee (is_for_hire=true)
    2. \n
  2. Assigned to the manager of the hired/terminated employee (is_for_manager=true)
    3. \n
  3. Assigned to a specific employee (the assignee_id should be provided)
    4. \n
\n

For any task assignment generated by this task, its deadline is derived from the due_date_value, due_date_period, and due_date_schedule attributes. If the due_date_value is set to -1, it indicates that the task assignment does not have a specified deadline.

\n

Additionally, if the TalentLMS integration is enabled, then you can connect the task with the completion of a particular course in TalentLMS by providing the course_id.

\n

Additionally, you have the option to integrate an available membership asset into the task by providing the asset_id. This is applicable only in onboarding tasks. However, this feature requires that your subscription for TalentHR supports the respective component. Upon the completion of the task the membership asset will be assigned to the hired employee.

\n

Note: You cannot select both an asset and a course in a task assignment; only one of them can be chosen.

\n

*For further information on talentLMS, you should check the TalentLMS documentation.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g.
due_date_valueintegertrueMin:-1 and Max: 3650.
If -1 then the task assignments created by this task will not have a deadline date.		e.g. 1
required_for_allbooleanRequired without 'task_required_for'e.g. true
task_required_forobjectRequired when 'required_for_all' is FALSE.Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array) with integer values (of Ids). At least one array within the object must contain at least one value.e.g.
holiday_required_for':{\"location\":[\"35\"],\"division\":[\"16\"],\"department\":[],\"job_title\":[],\"emp_state\":[]}'
assignee_idintegerOnly required if is_for_hire and is_for_manager are false.Unique identifier of active employees. Indicates that a specific employee is responsible for executing the current task.e.g. 1
is_for_hirebooleanRequired only if assignee_id is invalid and is_for_manager is false.Indicates a task that will be assigned to be executed by the hired or terminated employee.e.g. 1
is_for_managerbooleanRequired only if assignee_id is invalid and is_for_hire is false.Indicates a task that will be assigned to be executed by the manager of the hired or terminated employee.e.g. 1
task_category_idintegerfalseUnique identifier of task categories.e.g. 1
descriptionstringtrueMaximum character limit: 10000 characters.e.g 1
asset_idintegerfalseUnique identifier of assets.e.g 1
due_date_periodstringRequired unless Due date value is in -1Valid values are ['days', 'weeks', 'months']e.g days
due_date_schedulestringRequired unless Due date value is in -1Valid values are ['before', 'after']e.g before
course_idintegerfalseUnique identifier of TalentLMS courses.
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","tasks"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"c503e9b3-2f65-4d78-b3b4-880c090ac1cc","description":{"content":"

(Required) The task type (On-boarding or Off-boarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"}]}},"response":[{"id":"30851729-d121-42a0-a5c4-aae9689bfa7f","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"task_type_id\": \"\",\n \"due_date_value\": \"\",\n \"required_for_all\": \"\",\n \"assignee_id\": \"\",\n \"is_for_hire\": \"\",\n \"is_for_manager\": \"\",\n \"task_category_id\": \"\",\n \"description\": \"\",\n \"due_date_period\": \"\",\n \"due_date_schedule\": \"\",\n \"course_id\": \"\",\n \"asset_id\": \"\",\n \"task_required_for\": \"{\\\"location\\\":[36],\\\"division\\\":[],\\\"department\\\":[],\\\"job_title\\\":[],\\\"emp_state\\\":[]}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"tasks\": {\n \"id\": 13,\n \"name\": \"task-name\",\n \"description\": null,\n \"task_type_id\": 2,\n \"required_for_all\": false,\n \"due_date_period\": \"Months\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 1,\n \"assignee_id\": null,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:46:12\",\n \"deleted_at\": null,\n \"is_for_hire\": true,\n \"is_for_manager\": false,\n \"asset_id\": null,\n \"course_id\": 128,\n \"task_category_id\": 7,\n \"task_category_name\": \"task-category-name\",\n \"task_assignee_name\": \"Employee\",\n \"asset\": null,\n \"task_type\": {\n \"id\": 2,\n \"name\": \"Onboarding\"\n },\n \"task_required_for\": [\n {\n \"id\": 1,\n \"task_id\": 13,\n \"required_for_type\": \"job_title\",\n \"object_id\": 30,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:44:57\",\n \"deleted_at\": null,\n \"object_name\": \"object-name\",\n \"employee_custom_field\": {\n \"id\": 13,\n \"name\": \"object-name\",\n \"object_type\": \"division\"\n }\n }\n ]\n }\n}"},{"id":"24ceccbf-d1f9-4882-9641-cb180a40a3dc","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"task_type_id\": \"\",\n \"due_date_value\": \"\",\n \"required_for_all\": \"\",\n \"assignee_id\": \"\",\n \"is_for_hire\": \"\",\n \"is_for_manager\": \"\",\n \"task_category_id\": \"\",\n \"description\": \"\",\n \"due_date_period\": \"\",\n \"due_date_schedule\": \"\",\n \"course_id\": \"\",\n \"asset_id\": \"\",\n \"task_required_for\": \"{\\\"location\\\":[36],\\\"division\\\":[],\\\"department\\\":[],\\\"job_title\\\":[],\\\"emp_state\\\":[]}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"952777a6-df7e-4bee-95b6-ddad70a6127c","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"task_type_id\": \"\",\n \"due_date_value\": \"\",\n \"required_for_all\": \"\",\n \"assignee_id\": \"\",\n \"is_for_hire\": \"\",\n \"is_for_manager\": \"\",\n \"task_category_id\": \"\",\n \"description\": \"\",\n \"due_date_period\": \"\",\n \"due_date_schedule\": \"\",\n \"course_id\": \"\",\n \"asset_id\": \"\",\n \"task_required_for\": \"{\\\"location\\\":[36],\\\"division\\\":[],\\\"department\\\":[],\\\"job_title\\\":[],\\\"emp_state\\\":[]}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"57c988cd-f358-4204-b319-f18f7a760a45"},{"name":"Get the specified task","id":"6221370c-08f7-42e6-a0a1-8b9e4703d3d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","description":"

API endpoint to retrieve information about a specified task.

\n\n

This endpoint retrieves information for a specified task. To retrieve data, you must specify the task type for the endpoint, which can be either 'onboarding' or 'offboarding'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","tasks",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"0b0138cd-776f-4798-8983-c8eefc6349f5","description":{"content":"

(Required) The task type (On-boarding or Off-boarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"},{"id":"d17b680a-d062-4970-be8e-99bfcc12b75f","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"07a01ae8-9e8a-459f-aa0f-4d56651e2ab3","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"tasks\": {\n \"id\": 13,\n \"name\": \"task-name\",\n \"description\": null,\n \"task_type_id\": 2,\n \"required_for_all\": false,\n \"due_date_period\": \"Months\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 1,\n \"assignee_id\": null,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:46:12\",\n \"deleted_at\": null,\n \"is_for_hire\": true,\n \"is_for_manager\": false,\n \"asset_id\": null,\n \"course_id\": 128,\n \"task_category_id\": 7,\n \"task_category_name\": \"task-category-name\",\n \"task_assignee_name\": \"Employee\",\n \"asset\": null,\n \"task_required_for\": [\n {\n \"id\": 1,\n \"task_id\": 13,\n \"required_for_type\": \"job_title\",\n \"object_id\": 30,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:44:57\",\n \"deleted_at\": null,\n \"object_name\": \"object-name\"\n }\n ]\n }\n}"},{"id":"a4e72bf7-1349-4c53-8364-a21bed938464","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"6221370c-08f7-42e6-a0a1-8b9e4703d3d0"},{"name":"Update the specified task","id":"b8d666ed-49da-4a34-a83e-986700779628","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", //Required field. Maximum character limit:191 characters.\n \"due_date_value\": \"\", // Required field. Min:-1 and Max: 3650\n \"required_for_all\": \"\", //Required without 'task_required_for'.\n \"assignee_id\": \"\", // Only required if is_for_hire and is_for_manager are false. Unique identifier of active employee. Indicates that a specific employee is responsible for executing the current task.\n \"is_for_hire\": \"\", // Required only if assignee_id is invalid and is_for_manager is false. Indicates a task that will be assigned to be executed by the hired or terminated employee.\n \"is_for_manager\": \"\", // Required only if assignee_id is invalid and is_for_hire is false. Indicates a task that will be assigned to be executed by the manager of the hired or terminated employee.\n \"task_category_id\": \"\", // Not Required field. Unique identifier of task categories.\n \"description\": \"\", //Not Required field. Maximum character limit:10000 characters.\n \"due_date_period\": \"\", // Required unless Due date value is in -1. Valid values are ['days', 'weeks', 'months']\n \"due_date_schedule\": \"\",// Required unless Due date value is in -1. Valid values are ['Before', 'After']\n \"course_id\": \"\", // Not Required field. Unique identifier of TALENT-LSMS courses..\n \"asset_id\": \"\", // Not Required field. Unique identifier of assets.\n \"task_required_for\": { // Required when the 'required_for_all' is FALSE or 'required_for_all'is not present. Object with PROPERTIES: location (array), division (array), department (array), job_title (array), emp_state (array) that contains the Id's of the specified field. At least one array within the object must contain at least one value.\n \"location\": [\n \"\", // Unique identifier from locations.\n \"\" // Unique identifier from locations.\n ],\n \"division\": [\n \"\", // Unique identifier from divisions.\n \"\" // Unique identifier from divisions.\n ],\n \"department\": [\n \"\", // Unique identifier from departments.\n \"\" // Unique identifier from departments.\n ],\n \"job_title\": [\n \"\", // Unique identifier from job titles.\n \"\" // Unique identifier from job titles.\n ],\n \"emp_state\": [\n \"\", // Unique identifier from employment status.\n \"\" // Unique identifier from employment status.\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","description":"

API endpoint to update the specified task.

\n\n

This endpoint updates the specified new task. The request body should include the task's name, a description, the task's specific category, a due date for the task, a required_for_all flag indicating whether the task is mandatory for everyone, and some additional information specifying who will be assigned the task.

\n

In cases where required_for_all is set to FALSE, an additional parameter task_required_for must be included. This parameter delineates the specific department, division, location, job title, or employment status to which the task applies.

\n

As for who is going to run the task assignment, there are three options

\n
    \n
  1. Assigned to the hired/terminated employee (is_for_hire=true)
    2. \n
  2. Assigned to the manager of the hired/terminated employee (is_for_manager=true)
    3. \n
  3. Assigned to a specific employee (the assignee_id should be provided)
    4. \n
\n

The modifications will not impact any task assignments that are currently in progress.

\n

If the due_date_value is set to -1, it indicates that the task assignment does not have a specified deadline.

\n

Additionally, if the TalentLMS integration is enabled, then you can connect the task with the completion of a particular course in TalentLMS by providing the course_id.

\n

Additionally, you have the option to integrate an available membership asset into the task by providing the asset_id. This is applicable only in onboarding tasks. However, this feature requires that your subscription for TalentHR supports the respective component. Upon the completion of the task the membership asset will be assigned to the hired employee.

\n

Note: You cannot select both an asset and a course in a task assignment; only one of them can be chosen.

\n

*For further information on talentLMS, you should check the TalentLMS documentation.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g.
due_date_valueintegertrueMin:-1 and Max: 3650. If -1 then the task assignments created by this task will not have a deadline date.e.g. 1
required_for_allbooleanRequired without 'task_required_for'e.g. true
task_required_forobjectRequired when 'required_for_all' is FALSE.Object with the required properties: location (array), division (array), department (array), job_title (array), emp_state (array) with integer values (of Ids). At least one array within the object must contain at least one value.e.g.
holiday_required_for':{\"location\":[\"35\"],\"division\":[\"16\"],\"department\":[],\"job_title\":[],\"emp_state\":[]}'
assignee_idintegerOnly required if is_for_hire and is_for_manager are false.Unique identifier of active employees. Indicates that a specific employee is responsible for executing the current task.e.g. 1
is_for_hirebooleanRequired only if assignee_id is invalid and is_for_manager is false.Indicates a task that will be assigned to be executed by the hired or terminated employee.e.g. 1
is_for_managerbooleanRequired only if assignee_id is invalid and is_for_hire is false.Indicates a task tha will be assigned to be executed by the manager of the hired or terminated employee.e.g. 1
task_category_idintegerfalseUnique identifier of task categories.e.g. 1
descriptionstringtrueMaximum character limit: 10000 characters.e.g 1
asset_idintegerfalseUnique identifier of assets.e.g 1
due_date_periodstringRequired unless Due date value is in -1Enum value ['days', 'weeks', 'months']e.g days
due_date_schedulestringRequired unless Due date value is in -1Enum value ['Before', 'After']e.g Before
course_idintegerfalseUnique identifier of TalentLMS courses.
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","tasks",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"fecb8090-a78a-4404-8e91-f9137b8a253d","description":{"content":"

(Required) The task type (On-boarding or Off-boarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"},{"id":"ce230973-49a6-4069-b1fb-e4e8483a59ff","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"3d617367-0685-49d0-83a8-8515e92eec21","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"task_type_id\": \"\",\n \"due_date_value\": \"\",\n \"required_for_all\": \"\",\n \"assignee_id\": \"\",\n \"is_for_hire\": \"\",\n \"is_for_manager\": \"\",\n \"task_category_id\": \"\",\n \"description\": \"\",\n \"due_date_period\": \"\",\n \"due_date_schedule\": \"\",\n \"course_id\": \"\",\n \"asset_id\": \"\",\n \"task_required_for\": \"{\\\"location\\\":[36],\\\"division\\\":[],\\\"department\\\":[],\\\"job_title\\\":[],\\\"emp_state\\\":[]}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"tasks\": {\n \"id\": 13,\n \"name\": \"task-name\",\n \"description\": null,\n \"task_type_id\": 2,\n \"required_for_all\": false,\n \"due_date_period\": \"Months\",\n \"due_date_schedule\": \"After\",\n \"due_date_value\": 1,\n \"assignee_id\": null,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:46:12\",\n \"deleted_at\": null,\n \"is_for_hire\": true,\n \"is_for_manager\": false,\n \"asset_id\": null,\n \"course_id\": 128,\n \"task_category_id\": 7,\n \"task_category_name\": \"task-category-name\",\n \"task_assignee_name\": \"Employee\",\n \"asset\": null,\n \"task_required_for\": [\n {\n \"id\": 1,\n \"task_id\": 13,\n \"required_for_type\": \"job_title\",\n \"object_id\": 30,\n \"created_at\": \"2023-11-21 14:44:57\",\n \"updated_at\": \"2023-11-21 14:44:57\",\n \"deleted_at\": null,\n \"object_name\": \"object-name\"\n }\n ]\n }\n}"},{"id":"24fca2f5-15a5-483d-8487-1c8d86d34296","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"task_type_id\": \"\",\n \"due_date_value\": \"\",\n \"required_for_all\": \"\",\n \"assignee_id\": \"\",\n \"is_for_hire\": \"\",\n \"is_for_manager\": \"\",\n \"task_category_id\": \"\",\n \"description\": \"\",\n \"due_date_period\": \"\",\n \"due_date_schedule\": \"\",\n \"course_id\": \"\",\n \"asset_id\": \"\",\n \"task_required_for\": \"{\\\"location\\\":[36],\\\"division\\\":[],\\\"department\\\":[],\\\"job_title\\\":[],\\\"emp_state\\\":[]}\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"b8d666ed-49da-4a34-a83e-986700779628"},{"name":"Delete a task","id":"de72a79c-f3fc-4d0c-83de-de50b549a404","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","description":"

API endpoint to delete the specified task.

\n\n

This endpoint facilitates the deletion of the specified task. Any assignments upon this task will be removed.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["task-types",":taskType","tasks",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"3f428ac3-f377-4ef0-9d2e-9ee6821e6f9a","description":{"content":"

(Required) The task type (On-boarding or Off-boarding)

\n","type":"text/plain"},"type":"any","value":"","key":"taskType"},{"id":"9ee1cdde-61d8-4225-855b-5587c83fbc65","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"194b80d4-161c-4f70-ae64-9b03f38de3b0","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"f2be519d-2be6-4126-b5e4-ac0f49a540a4","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/task-types/:taskType/tasks/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["task-types",":taskType","tasks",":objectId"],"variable":[{"key":"taskType","value":"","description":"(Required) The task type (On-boarding or Off-boarding)"},{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"de72a79c-f3fc-4d0c-83de-de50b549a404"}],"id":"582b94c6-30fc-4ffa-aed7-40759d013198","_postman_id":"582b94c6-30fc-4ffa-aed7-40759d013198","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Documents","item":[{"name":"Get Company Documents","id":"d0c0cca0-e32d-4762-88ca-25e92e1121e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/documents/company-documents","description":"

API Endpoint to retrieve the company documents.

\n

This endpoint retrieves comprehensive information on all company files within this domain.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["documents","company-documents"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"48041486-3480-4410-a3a8-0b7522a9eaf7","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/documents/company-documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 2,\n \"uploaded_id\": 1,\n \"client_filename\": \"poster.png\",\n \"filename\": \"/testdomain/documents/NNcbnWBX/1702300272_poster.png\",\n \"filetype\": \"png\",\n \"is_employee_file\": false,\n \"is_public\": false,\n \"sort_order\": 0,\n \"created_at\": \"2023-11-16 07:33:51\",\n \"updated_at\": \"2024-02-13 11:51:33\",\n \"deleted_at\": null,\n \"owner_id\": 1,\n \"master_id\": null,\n \"preview_filename\": null,\n \"url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/documents/NNcbnWBX/1702300272_poster123.png?Expires=1707829193&Signature=wkZyul7nfEfVUbePUrTLF3B0qabz~dhNObNz-X9115lsH9hkRC6WyWoKdlqL1uBMb9lUBvIhWD1-MO2td-moqjqZcI5Lny1VpN55B3PmkBzjlOPljdneURRKm2bqeTOcjhp7cg9wKByrMHRMzZAX3CZdWsE3ZTpoJ7rMDYEyLST6tmHbyJ12ouDHpicbl75gd3lcE3PbXlm9nmy6q5NJkOIpBnCnWXfQLJ58exXzskCAz7Rm1EkSL0YXEzPVceZHPl62VWN9qwwczM6cQw1MYAUGUR8edD0DARi94eYEU-3Y6BnhPaV-gd6Gw5cmyVyupg55FHstnMJGfpCsOo6cmw__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"preview_url\": null\n }\n ]\n}"}],"_postman_id":"d0c0cca0-e32d-4762-88ca-25e92e1121e3"},{"name":"Create a company document","id":"750d7381-efeb-4fdc-8f36-a173f40d8518","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"document","description":"

(Required) File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv). The current document must not surpass 30MB

\n","type":"file","value":null}]},"url":"https://pubapi.talenthr.io/v1/documents/company-documents","description":"

API Endpoint to upload a company document.

\n

This endpoint facilitates the creation of a company file. The uploaded document should be in one of the valid formats: docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv, and must not exceed 30MB in size.

\n
\n

Filenames within the system must not start with any illegal character or symbol (e.g. @ (at sign), $ (dollar sign), % (percent), & (ampersand)) and should maintain a reasonable length, ensuring they do not exceed 250 characters.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
documentfiletrueFile. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv). The document can be up to 30MB.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["documents","company-documents"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"bdd9d9c8-9aa4-4866-bcbd-9239471ba06f","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"documents","value":"[\"\",\"\"]","description":"File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv)","type":"text"}]},"url":"https://pubapi.talenthr.io/v1/documents/company-documents"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"uploaded_id\": 1,\n \"client_filename\": \"poster.png\",\n \"filename\": \"/testdomain/documents/NNcbnWBX/1702300272_poster.png\",\n \"filetype\": \"png\",\n \"is_employee_file\": false,\n \"is_public\": false,\n \"sort_order\": 0,\n \"created_at\": \"2023-11-16 07:33:51\",\n \"updated_at\": \"2023-11-16 07:33:51\",\n \"deleted_at\": null,\n \"owner_id\": 1,\n \"master_id\": null,\n \"preview_filename\": null,\n \"url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/documents/NNcbnWBX/1702300272_poster123.png?Expires=1707829193&Signature=wkZyul7nfEfVUbePUrTLF3B0qabz~dhNObNz-X9115lsH9hkRC6WyWoKdlqL1uBMb9lUBvIhWD1-MO2td-moqjqZcI5Lny1VpN55B3PmkBzjlOPljdneURRKm2bqeTOcjhp7cg9wKByrMHRMzZAX3CZdWsE3ZTpoJ7rMDYEyLST6tmHbyJ12ouDHpicbl75gd3lcE3PbXlm9nmy6q5NJkOIpBnCnWXfQLJ58exXzskCAz7Rm1EkSL0YXEzPVceZHPl62VWN9qwwczM6cQw1MYAUGUR8edD0DARi94eYEU-3Y6BnhPaV-gd6Gw5cmyVyupg55FHstnMJGfpCsOo6cmw__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"preview_url\": null\n }\n}"},{"id":"1affbdae-7ef6-4f0b-b932-60e7b8b7cdfc","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"formdata","formdata":[{"key":"documents","value":"[\"\",\"\"]","description":"File. Valid Formats (docx,doc,odt,odp,ods,xls,xlsx,ppt,pptx,pdf,png,jpg,jpeg,svg,csv,gif,webp,tsv)","type":"text"}]},"url":"https://pubapi.talenthr.io/v1/documents/company-documents"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"750d7381-efeb-4fdc-8f36-a173f40d8518"},{"name":"Get a Document","id":"5f10cf3f-782a-4044-84c2-8d95bd1bc432","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/documents/:objectId","description":"

API Endpoint to retrieve the information of a document.

\n

This endpoint retrieves information for the specified document. The document can be either employee (private) or a company file.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["documents",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"08696fe9-d667-4247-b844-b7d295fbf828","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"cd0d230b-e6a8-487e-9006-5ceec4ac8e64","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/documents/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["documents",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"uploaded_id\": 1,\n \"client_filename\": \"poster.png\",\n \"filename\": \"/testdomain/documents/NNcbnWBX/1702300272_poster.png\",\n \"filetype\": \"png\",\n \"is_employee_file\": false,\n \"is_public\": false,\n \"sort_order\": 0,\n \"created_at\": \"2024-02-13 07:33:51\",\n \"updated_at\": \"2024-02-13 07:33:51\",\n \"deleted_at\": null,\n \"owner_id\": 1,\n \"master_id\": null,\n \"preview_filename\": null\n }\n}"},{"id":"c86d508c-16b6-43a4-8ce8-8503527d30fd","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/documents/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["documents",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"5f10cf3f-782a-4044-84c2-8d95bd1bc432"},{"name":"Update a Document","id":"bb62ab86-de0b-4b95-94bc-cbbdd51d6a8a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // The name of the current document. Maximum character limit: 191 characters.\n \"is_public\": \"\" // Opt for 'true' for public company file, else 'false' for private company file.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/documents/:objectId","description":"

API Endpoint to update the properties of a document (draft or not, filename).

\n

This endpoint updates the specified company document.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueThe name of the current document. Maximum character limit: 191 characters.-
is_publicbooleantrueOpt for 'true' for public company file, else 'false' for private company file.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["documents",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"596a9159-6fd1-42cf-b74c-812f09ec1b82","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"396eeb98-2836-43f1-873a-3f10b1e05718","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_public\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/documents/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["documents",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"uploaded_id\": 1,\n \"client_filename\": \"poster.png\",\n \"filename\": \"/testdomain/documents/NNcbnWBX/1702300272_poster.png\",\n \"filetype\": \"png\",\n \"is_employee_file\": false,\n \"is_public\": false,\n \"sort_order\": 0,\n \"created_at\": \"2023-11-16 07:33:51\",\n \"updated_at\": \"2023-11-16 07:33:51\",\n \"deleted_at\": null,\n \"owner_id\": 1,\n \"master_id\": null,\n \"preview_filename\": null,\n \"url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/documents/NNcbnWBX/1702300272_poster123.png?Expires=1707829193&Signature=wkZyul7nfEfVUbePUrTLF3B0qabz~dhNObNz-X9115lsH9hkRC6WyWoKdlqL1uBMb9lUBvIhWD1-MO2td-moqjqZcI5Lny1VpN55B3PmkBzjlOPljdneURRKm2bqeTOcjhp7cg9wKByrMHRMzZAX3CZdWsE3ZTpoJ7rMDYEyLST6tmHbyJ12ouDHpicbl75gd3lcE3PbXlm9nmy6q5NJkOIpBnCnWXfQLJ58exXzskCAz7Rm1EkSL0YXEzPVceZHPl62VWN9qwwczM6cQw1MYAUGUR8edD0DARi94eYEU-3Y6BnhPaV-gd6Gw5cmyVyupg55FHstnMJGfpCsOo6cmw__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"preview_url\": null\n }\n}"},{"id":"dd07bf13-8500-4033-bd3d-c270c6a985b3","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_public\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/documents/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["documents",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"bb62ab86-de0b-4b95-94bc-cbbdd51d6a8a"},{"name":"Delete a Document","id":"3c6b1ea2-774b-4e47-ace6-5042f2683d40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/documents/:objectId","description":"

API Endpoint to delete a document.

\n

This endpoint facilitates the deletion of the specified document. This endpoint can delete both employee (private) and company files.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["documents",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"1f6755f6-649c-42a3-9888-e2a7e7fcb249","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"5437b273-9059-48cc-87b5-edda1feb786a","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/documents/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["documents",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"e2d2ad0d-719e-4db8-871a-aa56f48e42c5","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/documents/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["documents",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"3c6b1ea2-774b-4e47-ace6-5042f2683d40"},{"name":"Update Documents' Order","id":"10b6d266-30bc-4074-8e5a-136a9028d2b4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documents\": [ // Array of documents' Ids. This array contains the IDs of all company documents in the specified order, where the first array value corresponds to the first document, the second array value corresponds to the second document, and so forth.\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/documents/alter-position","description":"

API Endpoint to change the order of the company documents.

\n

This endpoint alters the order of the company documents. The request body should include the \"documents\" attribute, which is an array containing the IDs of company files. The order of files corresponds to their position in this array (e.g., documents[0] represents the first document, documents[1] represents the second document, and so forth). For this functionality to operate correctly, all company documents must be present.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
documentsarraytrueThis array contains the IDs of all company documents in the specified order, where the first array value corresponds to the first document, the second array value corresponds to the second document, and so forth.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["documents","alter-position"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"4444fb1f-7efc-4fd7-baca-09e1363f62d7","name":"Simple boolean response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documents\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/documents/alter-position"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"14baa4b4-8604-4b37-ba7b-655cd5d950a4","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"documents\": [\n 1,\n 2,\n 3,\n 4,\n 5\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/documents/alter-position"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"10b6d266-30bc-4074-8e5a-136a9028d2b4"}],"id":"74726a11-fd87-4816-8553-c7d7db139349","_postman_id":"74726a11-fd87-4816-8553-c7d7db139349","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}},{"name":"Assets","item":[{"name":"Get all assets","id":"67dc19d2-511c-42c9-bb17-d94db836b84d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets?limit=&offset=&order=&sort=&filter=&search=","description":"

API endpoint to retrieve all assets.

\n\n

This endpoint retrieves comprehensive information regarding the domain's assets. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage). In addition to pagination parameters, users can customize the order and sorting of the retrieved data or search through them. The search option can only filter assets based on their name, description, or category.

\n

This endpoint offers also the flexibility to use filters for retrieving specific data based on your requirements. These filters could include the asset status (available, broken, etc) and the asset's category (if any). To retrieve the valid asset filters (and therefore the IDs you need), you should access the \"Get asset's default values\" endpoint.

\n
\n

The endpoint retrieves general info about the assets within our domain, as well as info about their status, category, and type.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum value ['asc','desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum value ['created_at', 'name', 'category', 'location', 'department', 'division', 'used_by', 'serial_number', 'warranty_end_date']

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Filters of Ids for the pagination ('status' => [], 'category' => []) Example: category=19,47;status=1,2,3,4,5

\n","type":"text/plain"},"key":"filter","value":""},{"description":{"content":"

Searching

\n","type":"text/plain"},"key":"search","value":""}],"variable":[]}},"response":[{"id":"efa0ec00-76bd-400a-9130-46781a587e9d","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets?limit=&offset=&order=&sort=&search=&filter=category=19,47;status=1,2,3,4,5","host":["https://pubapi.talenthr.io/v1"],"path":["assets"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""},{"key":"filter","value":"category=19,47;status=1,2,3,4,5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 2,\n \"rows\": [\n {\n \"id\": 10,\n \"name\": \"membership-name\",\n \"asset_type_id\": 2,\n \"asset_category_id\": 6,\n \"asset_status_id\": 2,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"created_at\": \"2024-02-14 08:35:09\",\n \"updated_at\": \"2024-02-14 08:35:09\",\n \"deleted_at\": null,\n \"cost_currency\": \"EUR\",\n \"in_warranty\": null,\n \"users_count\": 1,\n \"asset_status\": {\n \"id\\\"\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_category\\\"\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n },\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n }\n },\n {\n \"id\": 9,\n \"name\": \"inventory-name\",\n \"asset_type_id\": 1,\n \"asset_category_id\": 5,\n \"asset_status_id\": 1,\n \"serial_number\": \"serial-number\",\n \"label\": \"label-name\",\n \"cost_frequency\": \"once-off\",\n \"cost_model\": null,\n \"cost\": \"100.00\",\n \"purchase_date\": \"2020-01-01\",\n \"warranty_end_date\": \"2024-12-31\",\n \"created_at\": \"2024-02-13 14:02:02\",\n \"updated_at\": \"2024-02-13 14:02:51\",\n \"deleted_at\": null,\n \"cost_currency\": \"EUR\",\n \"in_warranty\": true,\n \"users_count\": 1,\n \"asset_status\": {\n \"id\": 1,\n \"slug\": \"in-use\",\n \"name\": \"In use\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 5,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n },\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n }\n }\n ]\n }\n}"}],"_postman_id":"67dc19d2-511c-42c9-bb17-d94db836b84d"},{"name":"Get an asset","id":"96a9da9b-5366-4e80-97ae-6488c0cd17e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId","description":"

API endpoint to fetch information about a specified asset.

\n\n

This endpoint is designed to fetch details for a specified asset, which may be classified as either a membership asset or an inventory one. It provides comprehensive data including general information about the asset, its status, type, category, available actions, and custom fields associated with it. Furthermore, for inventory assets, it includes additional details regarding the assignment of the asset to an employee.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"692e5d6a-4ea1-42b8-a0a4-32ed6e70f6c9","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"bf03418d-6f9f-4da5-aa2b-70084e9f6a29","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 11,\n \"name\": \"membership-name\",\n \"asset_category_id\": 6,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"description\": \"This is a description...\",\n \"created_at\": \"2024-02-14 09:28:07\",\n \"updated_at\": \"2024-02-14 09:28:55\",\n \"deleted_at\": null,\n \"asset_type_id\": 2,\n \"available_actions\": [\n {\n \"id\": 5,\n \"slug\": \"retired\",\n \"name\": \"Retired\",\n \"is_enabled\": 1,\n \"is_reverse_action\": 0\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_id\": 1,\n \"custom_field_slug\": \"custom-field-1\",\n \"custom_field_name\": \"Custom Field 1\",\n \"values\": []\n },\n {\n \"custom_field_id\": 2,\n \"custom_field_slug\": \"custom-field-2\",\n \"custom_field_name\": \"Custom Field 2\",\n \"values\": []\n }\n ],\n \"in_warranty\": null,\n \"users_count\": 0,\n \"cost_currency\": \"EUR\",\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n },\n \"asset_status\": {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n}"},{"id":"837c2e0a-5894-45f7-a519-f62e4edec1e6","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"96a9da9b-5366-4e80-97ae-6488c0cd17e6"},{"name":"Clone an asset","id":"d0a0ec83-4ba8-496f-8653-4136ad4757e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId","description":"

API endpoint to clone the specified asset.

\n\n

This endpoint allows for the cloning of an existing asset. The asset being cloned must be valid and must already exist within the system.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"eef32a8a-ea3c-422e-916d-9979b1a06c26","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"02c8b2fc-8c2c-469a-b19d-c4bfb34cf732","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"name\": \"membership-name (Copy)\",\n \"asset_category_id\": 6,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"description\": \"This is a description...\",\n \"deleted_at\": null,\n \"asset_type_id\": 2,\n \"updated_at\": \"2024-02-14 11:54:29\",\n \"created_at\": \"2024-02-14 11:54:29\",\n \"id\": 12,\n \"asset_status\": {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n },\n \"asset_category\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n}"},{"id":"68c19cac-fa71-49ce-901d-c1cf0247d017","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"d0a0ec83-4ba8-496f-8653-4136ad4757e1"},{"name":"Update an asset","id":"6c62310b-3847-45f0-aad9-6ffdbed81066","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"\", // Required field. Maximum character limit:191 characters.\n\"asset_category_id\": \"\", // Not required field. Unique identifier of asset categories.\n\"cost_model\": \"\", // For Membership asset is required when cost_frequency or cost is present. For inventory is not required. Valid values are [per-user, per-company]\n\"serial_number\": \"\", // Required if asset_type_slug is invetory. Maximum character limit:255 characters.\n\"label\": \"\", // Not Required field. Maximum character limit:255 characters.\n\"cost_frequency\": \"\", // For Inventory asset is required only when cost is present. For Membership asset is required when cost or cost_model is present. Valid values are [per-year, per-month, once-off]\n\"cost\": \"\", // For Inventory asset is required only when cost_frequency is present .For Membership asset is required when cost_frequency or cost_model is present. This value must be represented as a number with two decimal places.\n\"purchase_date\": \"\", // Not Required field. The purchase_date must be formatted as 'YYYY-MM-DD'.\n\"warranty_end_date\": \"\", // Not Required field. The warranty_end_date must be after of purchase_date. The warranty_end_date must be formatted as 'YYYY-MM-DD'.\n\"employee_id\": \"\", // Required if assign_date is present. Unique identifier of active employees. If the asset has status 'retired' the employee cannot be assigned.\n\"assign_date\": \"\", // Required if employee_id is present. The assign_date must be after or equal of purchase_date. The assign_date must be formatted as 'YYYY-MM-DD'.\n\"location_id\": \"\", // Not Required field. Unique identifier of locations.\n\"division_id\": \"\", // Not Required field. Unique identifier of divisions.\n\"department_id\": \"\", // Not Required field. Unique identifier of departments.\n\"description\": \"\", // Not Required field. Maximum character limit:10000 characters.\n\"custom_field_01\": \"\", // Custom Field (Type: Text). Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_02\": \"\", // Custom Field (Type: Long Text). Maximum character limit: 5000 characters. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_03\": \"\", // Custom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_04\": [ // Custom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n \"\",\n \"\"\n ],\n\"custom_field_05\": \"\", // Custom Field (Type: Date). The custom-field's date must be formatted as 'YYYY-MM-DD'. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_06\": \"\", // Custom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_07\": \"\" // Custom Field (Type: Employee). This custom field must contain the Id of the Employee. The custom field's name (key) corresponds to the slug of the custom field.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/:objectId","description":"

API endpoint to update the specified asset.

\n\n

This endpoint facilitates the modification of a specified asset, which may be classified as either a membership or an inventory asset. The update process requires specifying certain attributes that are common to both types of assets, as well as other attributes that are unique to either membership or inventory assets.

\n

For both asset types, the request body should include the asset's name, category (if applicable), model cost, cost frequency, cost, purchase date, and description. Additionally, inventory assets may include a serial number, label, warranty end date and details regarding the asset's assignment, such as employee ID, assignment date, location, department, and division.

\n

Both types of assets also support the inclusion of custom fields in the update process. These custom fields, however, may vary between inventory and membership assets. To accurately update an asset, it's crucial to first identify the relevant custom fields for that asset type, as the inventory custom fields might differ from those associated with membership assets.

\n
\n

When updating an asset, you can modify the custom fields associated with that asset. However, it is important to note that the availability of this feature is dependent on your TalentHR subscription (Refer to the Introductory chapter for further details). The custom fields associated with an asset can be retrieved using the 'Get asset's custom fields' endpoint.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g.
asset_category_idintegerfalseUnique identifier of asset categories.e.g. 1
cost_modelstringtrueFor Membership asset is required when cost_frequency or cost is present. For inventory is not required. Valid values are ['per-user', 'per-company']e.g. per-user
serial_numberstringRequired if asset_type_slug is inventory.Maximum character limit: 255 characters.e.g. 1234
labelstringNot Required field.Maximum character limit: 255 characters.e.g. PUB API ASSET
cost_frequencystringFor Inventory asset is required only when cost is present. For Membership asset is required when cost or cost_model is present.Valid values are ['per-year', 'per-month', 'once-off'] .e.g. per-month
costnumberFor Inventory asset is required only when cost_frequency is present .For Membership asset is required when cost_frequency or cost_model is present.This value must be represented as a number with two decimal places (optional).e.g. 450.99 or 451
purchase_datedatefalseThe purchase_date must be formatted as 'YYYY-MM-DD'.e.g. 2024-04-06
warranty_end_datedatefalseThe warranty_end_date must be after of purchase_date. The warranty_end_date must be formatted as 'YYYY-MM-DD'.e.g. 2024-04-06
assign_datedateRequired if employee_id is present.The assign_date must be after or equal of purchase_date. The warranty_end_date must be formatted as 'YYYY-MM-DD'.e.g. 2024-04-06
employee_idintegerRequired if assign_date is present.Unique identifier of active employees. If the asset has status 'retired' the employee cannot be assigned.e.g. 1
location_idintegerfalseUnique identifier of locations.e.g. 1
division_idintegerfalseUnique identifier of divisions.e.g. 1
department_idintegerfalseUnique identifier of departments.e.g. 1
division_idintegerfalseUnique identifier of divisions.e.g. 1
descriptionstringfalseMaximum character limit:10000 characters.e.g.
custom_field_01stringfalseCustom Field (Type: Text). Maximum character limit: 255 characters.e.g. \"This is a text...\"
custom_field_02stringfalseCustom Field (Type: Long Text). Maximum character limit: 5000 characters.e.g. \"This is a long text...\"
custom_field_03integerfalseCustom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options.e.g. 3
custom_field_04arrayfalseCustom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options.e.g. [3,4]
custom_field_05datefalseCustom Field (Type: Date). The custom field's date must be formatted as 'YYYY-MM-DD'.e.g. 2024-03-10
custom_field_06stringfalseCustom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters.e.g. \"https://www.domainexample.com/\"
custom_field_07integerfalseCustom Field (Type: Employee). This custom field must contain the Id of the Employee.e.g. 1
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"f9a4b74b-ff40-4cd5-8499-8b996f857827","type":"any","value":"6","key":"objectId"}]}},"response":[{"id":"9a14dbcb-b404-4c67-8722-9d10411830de","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 11,\n \"name\": \"membership-name\",\n \"asset_category_id\": 6,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"description\": \"This is a description...\",\n \"created_at\": \"2024-02-14 09:28:07\",\n \"updated_at\": \"2024-02-14 09:28:55\",\n \"deleted_at\": null,\n \"asset_type_id\": 2,\n \"available_actions\": [\n {\n \"id\": 5,\n \"slug\": \"retired\",\n \"name\": \"Retired\",\n \"is_enabled\": 1,\n \"is_reverse_action\": 0\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_id\": 1,\n \"custom_field_slug\": \"custom-field-1\",\n \"custom_field_name\": \"Custom Field 1\",\n \"values\": []\n },\n {\n \"custom_field_id\": 2,\n \"custom_field_slug\": \"custom-field-2\",\n \"custom_field_name\": \"Custom Field 2\",\n \"values\": []\n }\n ],\n \"in_warranty\": null,\n \"users_count\": 0,\n \"cost_currency\": \"EUR\",\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n },\n \"asset_status\": {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n}"},{"id":"46c4e8f8-467b-4b09-bfc2-c9b56a2f2d20","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"8c63de5f-758d-42d6-966b-cf090e12fbb6","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"6c62310b-3847-45f0-aad9-6ffdbed81066"},{"name":"Delete an asset","id":"69ade617-2b8e-4b3b-be10-5e8323a1f9d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId","description":"

API endpoint to delete the specified asset.

\n\n

This endpoint enables the removal of the specified asset from the system. Along with the asset, any associated employee assignments will also be eliminated. Furthermore, upon the asset's deletion, all tasks and task assignments linked to this asset will be deleted. Additionally, the historical records about the asset will be also permanently deleted.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"70583989-cff9-4de5-af3f-561776366dec","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"b00e08f2-9e7f-477c-ab88-61b50d25fe5d","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"3ddbd71a-af8d-4fc7-a37b-3e8b215b9bad","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"69ade617-2b8e-4b3b-be10-5e8323a1f9d2"},{"name":"Get all assets of membership type","id":"7abb3bd9-5af3-40a0-a294-0a46e37efae8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/membership?limit=&offset=&order=&sort=&search=&filter=","description":"

API endpoint to retrieves all the assets of membership type.

\n\n

This endpoint retrieves comprehensive information regarding the domain's membership assets. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage). In addition to pagination parameters, users can customize the order and sorting of the retrieved data or search through them. The search option can only filter assets based on their name, description, or category.

\n

This endpoint offers also the flexibility to use filters for retrieving specific data based on your requirements. These filters could include the asset status (available, retired) and the asset's category (if any). To retrieve the valid asset filters (and therefore the IDs you need), you should access the \"Get asset's default values\" endpoint.

\n
\n

The endpoint retrieves general info about the membership assets within our domain, as well as info about their status, category, and type.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum value ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum value ['created_at', 'name', 'category', 'location', 'department', 'division', 'used_by', 'serial_number', 'warranty_end_date']

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Searching

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

Filters of Ids for the pagination ('status' => [], 'category' => []). Example : category=19,47;status=1,2,3,4,5

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"38bb16d4-c468-4c88-b315-a4cf9fd9c22f","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership?limit=&offset=&order=&sort=&search=&filter=category=19,47;status=1,2,3,4,5","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""},{"key":"filter","value":"category=19,47;status=1,2,3,4,5"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 11,\n \"name\": \"membership-name\",\n \"asset_category_id\": 6,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"description\": \"This is a description...\",\n \"created_at\": \"2024-02-14 09:28:07\",\n \"updated_at\": \"2024-02-14 09:28:55\",\n \"deleted_at\": null,\n \"asset_type_id\": 2,\n \"in_warranty\": null,\n \"users_count\": 0,\n \"cost_currency\": \"EUR\",\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n },\n \"asset_status\": {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n ]\n }\n}"}],"_postman_id":"7abb3bd9-5af3-40a0-a294-0a46e37efae8"},{"name":"Create a membership type asset","id":"df2053ea-993d-4042-ad7c-3813f6640ccf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\"name\": \"\", // Required field. Maximum character limit:191 characters.\n\"asset_category_id\": \"\", // Not required field. Unique identifier of asset categories.\n\"cost_model\": \"\", // For Membership asset is required when cost_frequency or cost is present. Valid values are [per-user, per-company]\n\"serial_number\": \"\", // Required if asset type is invetory. Maximum character limit:255 characters.\n\"label\": \"\", // Not Required field. Maximum character limit:255 characters.\n\"cost_frequency\": \"\", // For Inventory asset is required only when cost is present. For Membership asset is required when cost or cost_model is present. Valid values are [per-year, per-month, once-off]\n\"cost\": \"\", // For Membership asset is required when cost_frequency or cost_model is present. Cost's value can have up to 2 decimals\n\"purchase_date\": \"\", // Not Required field. The purchase_date must be formatted as 'YYYY-MM-DD'.\n\"warranty_end_date\": \"\", // Not Required field. The warranty_end_date must be after of purchase_date. The warranty_end_date must be formatted as 'YYYY-MM-DD'.\n\"employee_id\": \"\", // Required if assign_date is present. Unique identifier of active employees.\n\"assign_date\": \"\", // Required if employee_id is present. The assign_date must be after or equal of purchase_date The assign_date must be formatted as 'YYYY-MM-DD'.\n\"location_id\": \"\", // Not Required field. Unique identifier of locations.\n\"division_id\": \"\", // Not Required field. Unique identifier of divisions.\n\"department_id\": \"\", // Not Required field. Unique identifier of departments.\n\"description\": \"\", // Not Required field. Maximum character limit:10000 characters.\n\"custom_field_01\": \"\", // Custom Field (Type: Text). Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_02\": \"\", // Custom Field (Type: Long Text). Maximum character limit: 5000 characters. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_03\": \"\", // Custom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_04\": [ // Custom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n \"\",\n \"\"\n ],\n\"custom_field_05\": \"\", // Custom Field (Type: Date). The custom-field's date must be formatted as 'YYYY-MM-DD'. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_06\": \"\", // Custom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n\"custom_field_07\": \"\" // Custom Field (Type: Employee). This custom field must contain the Id of the Employee. The custom field's name (key) corresponds to the slug of the custom field.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership","description":"

API endpoint to create a membership type asset.

\n\n

This endpoint facilitates the creation of a membership asset. The request body should include the asset's name, category (if applicable), model cost, cost frequency, cost, purchase date, and description.

\n

Membership assets also support the inclusion of custom fields in the creation process. To accurately set a value to an asset custom field, it's crucial to first identify the relevant custom fields for that asset type.

\n
\n

When creating a membership asset, you can also integrate the custom fields associated with that asset. However, it is important to note that the availability of this feature is dependent on your TalentHR subscription (Refer to the Introductory chapter for further details). The custom fields associated with an asset can be retrieved using the 'Get all assets custom fields' endpoint.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g. Asset1
asset_category_idintegerfalseUnique identifier of asset categories.e.g. 1
cost_modelstringFor Membership asset is required when cost_frequency or cost is present. For inventory is not required.Valid values are [\"per-user\", \"per-company\"]e.g. per-user
cost_frequencystringFor Membership asset is required when cost or cost_model is present.Valid values are [per-year, per-month, once-off] .e.g. per-month
coststringFor Membership asset is required when cost_frequency or cost_model is present.Cost's value can have up to 2 decimalse.g. 450.99
purchase_datedatefalseThe purchase_date must be formatted as 'YYYY-MM-DD'e.g. 2024-04-06
descriptionstringNot Required fieldMaximum character limit:10000 characters.e.g.
custom_field_01stringfalseCustom Field (Type: Text). Maximum character limit: 255 characters.e.g. \"This is a text...\"
custom_field_02stringfalseCustom Field (Type: Long Text). Maximum character limit: 5000 characters.e.g. \"This is a long text...\"
custom_field_03integerfalseCustom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options.e.g. 3
custom_field_04arrayfalseCustom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options.e.g. [3,4]
custom_field_05datefalseCustom Field (Type: Date). The custom field's date must be formatted as 'YYYY-MM-DD'.e.g. 2024-03-10
custom_field_06stringfalseCustom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters.e.g. \"https://www.domainexample.com/\"
custom_field_07integerfalseCustom Field (Type: Employee). This custom field must contain the Id of the Employee.e.g. 1
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"bf30781e-ec5d-42b5-9d47-1e5eaad130ea","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 11,\n \"name\": \"membership-name\",\n \"asset_category_id\": 6,\n \"serial_number\": null,\n \"label\": null,\n \"cost_frequency\": \"per-month\",\n \"cost_model\": \"per-user\",\n \"cost\": \"15.99\",\n \"purchase_date\": \"2024-02-01\",\n \"warranty_end_date\": null,\n \"asset_status_id\": 2,\n \"description\": \"This is a description...\",\n \"created_at\": \"2024-02-14 09:28:07\",\n \"updated_at\": \"2024-02-14 09:28:55\",\n \"deleted_at\": null,\n \"asset_type_id\": 2,\n \"available_actions\": [\n {\n \"id\": 5,\n \"slug\": \"retired\",\n \"name\": \"Retired\",\n \"is_enabled\": 1,\n \"is_reverse_action\": 0\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_id\": 1,\n \"custom_field_slug\": \"custom-field-1\",\n \"custom_field_name\": \"Custom Field 1\",\n \"values\": []\n },\n {\n \"custom_field_id\": 2,\n \"custom_field_slug\": \"custom-field-2\",\n \"custom_field_name\": \"Custom Field 2\",\n \"values\": []\n }\n ],\n \"in_warranty\": null,\n \"users_count\": 0,\n \"cost_currency\": \"EUR\",\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Subscription\"\n },\n \"asset_status\": {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 6,\n \"name\": \"category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n}"},{"id":"9d4716c4-fa05-4f38-b31a-200a0c0cf481","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"df2053ea-993d-4042-ad7c-3813f6640ccf"},{"name":"Get all assets categories of membership type","id":"315e4bdb-9ec7-42c0-a86d-f01f702bf751","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/membership/categories","description":"

API endpoint to retrieve all the available categories for a membership type asset.

\n\n

This endpoint retrieves comprehensive information on the membership categories.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership","categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"65998881-eca7-4983-8776-901a1af89776","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/membership/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"asset_type_id\": 2,\n \"name\\\"\": \"membership-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:28:26\",\n \"updated_at\": \"2023-11-16 13:03:57\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n }\n ]\n}"}],"_postman_id":"315e4bdb-9ec7-42c0-a86d-f01f702bf751"},{"name":"Create a category for the membership assets","id":"6a8cf2a8-4b01-4fb3-85db-f655b14be9f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" //Required field. Maximum character limit:191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership/categories","description":"

API endpoint to create a new category for the membership assets.

\n\n

This endpoint facilitates the creation of a new membership asset category. You should provide the name of the current category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueMaximum character limit: 191 characters.e.g. Employee Benefits Club
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership","categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"e232c7d7-d531-4209-9908-35af867dea39","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"asset_type_id\": 2,\n \"name\": \"membership-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:28:26\",\n \"updated_at\": \"2023-11-16 13:03:57\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n }\n}"},{"id":"46f24a2d-a08b-4a2a-a284-501506b39580","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership/categories"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"6a8cf2a8-4b01-4fb3-85db-f655b14be9f3"},{"name":"Get a membership category","id":"266ddee8-bffd-4258-82d6-fd71276db398","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","description":"

API endpoint to retrieve the specified membership category.

\n\n

This endpoint retrieves information for the specified membership category.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership","categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b6379e41-165a-4287-ae6f-a8ca69b5d8d2","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c5421fc2-9fcd-464c-805a-a984fd9eb24b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"asset_type_id\": 2,\n \"name\": \"membership-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:28:26\",\n \"updated_at\": \"2023-11-16 13:03:57\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n }\n}"},{"id":"a418cda2-5362-44e1-8091-967abfb9b711","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"266ddee8-bffd-4258-82d6-fd71276db398"},{"name":"Update a membership category","id":"98bdfff0-eacc-4b88-ae0a-d0e3ce4afe82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required field without is_enabled. Maximum character limit:191 characters.\n \"is_enabled\": \"\" // Required without name.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","description":"

API endpoint to update the specified membership category.

\n\n

This endpoint facilitates the modification for the specified membership asset category. You should provide the name of the current category.

\n

Request parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringRequired without is_enabled.Maximum character limit: 191 characters.e.g. Employee Benefits Club
is_enabledbooleanRequired without name.e.g. true
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership","categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"8eaba111-6ab5-474f-b251-a8cb4f226627","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"b3a0198e-dada-40c8-8e11-9213736f9e15","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"asset_type_id\": 2,\n \"name\": \"membership-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:28:26\",\n \"updated_at\": \"2023-11-16 13:03:57\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n }\n}"},{"id":"734cc06a-ad83-4aad-9111-a1f2735774b5","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"976c30c8-586f-4666-8b39-ba4c877f5d62","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"98bdfff0-eacc-4b88-ae0a-d0e3ce4afe82"},{"name":"Delete a membership category","id":"bd8d9bf4-018c-4178-aac9-df7073c4e16b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","description":"

API Endpoint to delete the specified membership category.

\n

This endpoint facilitates the deletion of the specified membership category. If there are assets within this category the deletion cannot be done.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","membership","categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"aee9224b-a2e3-4b52-9de0-23179283fc5a","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"456baa12-6de7-445e-980c-0d9af02a096b","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"ca51ff10-b8c3-4c68-8a7e-0bbbe3590dc2","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/membership/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","membership","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"bd8d9bf4-018c-4178-aac9-df7073c4e16b"},{"name":"Get all assets of inventory type","id":"d888383f-d511-45cd-8444-d5e1ced03844","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/inventory?limit=&offset=&order=&sort=&search=&filter=","description":"

API Endpoint to retrieve all the assets of inventory type.

\n

This endpoint retrieves comprehensive information regarding the domain's inventory assets. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage). In addition to pagination parameters, users can customize the order and sorting of the retrieved data or search through them. The search option can filter assets based on their name, description, category, label, serial number and division, department, location if there is an employee assignment.

\n

This endpoint offers also the flexibility to use filters for retrieving specific data based on your requirements. These filters could include the asset status (available, broken, retired, in service, in use), the asset's category (if any), the warrany, and any location, division, department. To retrieve the valid asset filters (and therefore the IDs you need), you should access the \"Get asset's default values\" endpoint.

\n
\n

The endpoint retrieves general info about the inventory assets within our domain, as well as info about their status, category, and type.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum value ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum value ['created_at', 'name', 'category', 'location', 'department', 'division', 'used_by', 'serial_number', 'warranty_end_date']

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Searching

\n","type":"text/plain"},"key":"search","value":""},{"description":{"content":"

Filters of Ids for the pagination ('location' => [], 'department' => [], 'division' => [], 'status' => [], 'category' => [], 'warranty' => []). Example: category=19,47;status=1,2,3,4,5;location=35,37;department=6,10;division=14,74

\n","type":"text/plain"},"key":"filter","value":""}],"variable":[]}},"response":[{"id":"771129b1-0f3f-43c4-89e6-02e31e631463","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory?limit=&offset=&order=&sort=&search=&filter=category=19,47;status=1,2,3,4,5;location=35,37;department=6,10;division=14,74","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""},{"key":"filter","value":"category=19,47;status=1,2,3,4,5;location=35,37;department=6,10;division=14,74"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 9,\n \"name\": \"inventory-name\",\n \"asset_type_id\": 1,\n \"asset_category_id\": 5,\n \"serial_number\": \"14785236900\",\n \"label\": \"label-name\",\n \"cost_frequency\": \"once-off\",\n \"cost_model\": null,\n \"cost\": \"100.00\",\n \"purchase_date\": \"2020-01-01\",\n \"warranty_end_date\": \"2024-12-31\",\n \"asset_status_id\": 1,\n \"description\": null,\n \"created_at\": \"2024-02-13 14:02:02\",\n \"updated_at\": \"2024-02-13 14:02:51\",\n \"deleted_at\": null,\n \"in_warranty\": true,\n \"users_count\": 1,\n \"cost_currency\": \"EUR\",\n \"asset_status\": {\n \"id\": 1,\n \"slug\": \"in-use\",\n \"name\": \"In use\",\n \"is_enabled\": 1\n },\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n },\n \"asset_category\": {\n \"id\": 5,\n \"name\": \"asset-category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n }\n }\n ]\n }\n}"}],"_postman_id":"d888383f-d511-45cd-8444-d5e1ced03844"},{"name":"Create an inventory type asset","id":"b92274ec-046a-4e6f-b5e5-d476fe12f1f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // (Required) The name of the current inventory asset. Maximum character limit: 191 characters.\n \"asset_category_id\": \"\", // The asset's category Id.\n \"serial_number\": \"\", // Maximum character limit: 255 characters.\n \"label\": \"\", // Maximum character limit: 255 characters.\n \"cost_frequency\": \"\", // Enum value [per-month, per-year, once-off]. The frequenct cost of the current asset.\n \"cost\": \"\", // The cost of the current asset. This value must be represented as a number with two decimal places.\n \"purchase_date\": \"\", // The purchase date must be formatted as 'YYYY-MM-DD'.\n \"warranty_end_date\": \"\", // The warranty end date must be formatted as 'YYYY-MM-DD'.\n \"employee_id\": \"\", // The assigned employee for the current asset. This field is required with 'assign_date'.\n \"assign_date\": \"\", // The assign date must be formatted as 'YYYY-MM-DD'. This field is required with 'employee_id'. The date value must be after or equal the 'purchase_date'\n \"location_id\": \"\", // The assigned location for the current asset.\n \"division_id\": \"\", // The assigned division for the current asset.\n \"department_id\": \"\", // The assigned department for the current asset.\n \"description\": \"\", // Asset's description. Up to 10000 characters.\n \"custom_field_01\": \"\", // Custom Field (Type: Text). Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_02\": \"\", // Custom Field (Type: Long Text). Maximum character limit: 5000 characters. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_03\": \"\", // Custom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_04\": [ // Custom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.\n \"\",\n \"\"\n ],\n \"custom_field_05\": \"\", // Custom Field (Type: Date). The custom-field's date must be formatted as 'YYYY-MM-DD'. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_06\": \"\", // Custom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.\n \"custom_field_07\": \"\" // Custom Field (Type: Employee). This custom field must contain the Id of the Employee. The custom field's name (key) corresponds to the slug of the custom field.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory","description":"

API Endpoint to create an inventory-type asset.

\n

This endpoint facilitates the creation of an inventory asset. The request body should include the asset's name, category (if applicable), model cost, cost frequency, cost, label, serial number, purchase date, warranty end date, and description. Additionally, inventory assets include details regarding the asset's assignment, such as employee ID, assignment date, location, department, and division.

\n

Inventory assets also support the inclusion of custom fields in the creation process. To accurately set a value to an asset custom field, it's crucial to first identify the relevant custom fields for that asset type.

\n
\n

When creating an inventory asset, you can also integrate the custom fields associated with that asset. However, it is important to note that the availability of this feature is dependent on your TalentHR subscription (Refer to the Introductory chapter for further details). The custom fields associated with an asset can be retrieved using the 'Get all assets custom fields' endpoint.

\n
\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueThe name of the current inventory asset. Maximum character limit: 191 characters.-
asset_category_idintegerfalseThe asset's category Id.-
serial_numberstringtrueMaximum character limit: 255 characters.-
labelstringfalseMaximum character limit: 255 characters.-
cost_frequencyenumRequired with cost.The frequency cost of the current asset.per-month, per-year, once-off
costnumberRequired with cost frequencyThe cost of the current asset. This value must be represented as a number with two decimal places.e.g. 123.45 or 123
purchase_datedatefalseThe purchase date must be formatted as 'YYYY-MM-DD'.e.g. 2024-01-05
warranty_end_datedatefalseThe warranty end date must be formatted as 'YYYY-MM-DD'. The end date also must be after the purchase date.e.g. 2027-01-05
employee_idintegerfalseThe assigned employee for the current asset. This field is required with 'assign_date'.-
assign_datedatefalseThe assign date must be formatted as 'YYYY-MM-DD'. This field is required with 'employee_id'. The date value must be after or equal the 'purchase_date'e.g. 2024-01-10
location_idintegerfalseThe assigned location for the current asset.-
division_idintegerfalseThe assigned division for the current asset.-
department_idintegerfalseThe assigned department for the current asset.-
descriptionstringfalseAsset's description. Up to 10000 characters.-
custom_field_01stringfalseCustom Field (Type: Text). Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.e.g. \"This is a text...\"
custom_field_02stringfalseCustom Field (Type: Long Text). Maximum character limit: 5000 characters. The custom field's name (key) corresponds to the slug of the custom field.e.g. \"This is a long text...\"
custom_field_03integerfalseCustom Field (Type: Single Choice). This field requires the ID of the selected value from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.e.g. 1
custom_field_04arrayfalseCustom Field (Type: Multiple Choice). This field requires the IDs of the selected values from the array of available options. The custom field's name (key) corresponds to the slug of the custom field.e.g. [3,4]
custom_field_05datefalseCustom Field (Type: Date). The custom-field's date must be formatted as 'YYYY-MM-DD'. The custom field's name (key) corresponds to the slug of the custom field.e.g. 2024-03-10
custom_field_06stringfalseCustom Field (Type: Link). This value has to be a valid URL. Maximum character limit: 255 characters. The custom field's name (key) corresponds to the slug of the custom field.e.g. https://www.exampledomain.com/
custom_field_07integerfalseCustom Field (Type: Employee). This custom field must contain the Id of the Employee. The custom field's name (key) corresponds to the slug of the custom field.e.g. 1
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"a08a1845-caf7-4642-9d66-351bb383afc4","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 9,\n \"name\": \"inventory-name\",\n \"asset_category_id\": 5,\n \"serial_number\": \"14785236900\",\n \"label\": \"label-name\",\n \"cost_frequency\": \"once-off\",\n \"cost_model\": null,\n \"cost\": \"100.00\",\n \"purchase_date\": \"2020-01-01\",\n \"warranty_end_date\": \"2024-12-31\",\n \"asset_status_id\": 1,\n \"description\": null,\n \"created_at\": \"2024-02-13 14:02:02\",\n \"updated_at\": \"2024-02-13 14:02:51\",\n \"deleted_at\": null,\n \"asset_type_id\": 1,\n \"available_actions\": [\n {\n \"id\": 4,\n \"slug\": \"broken\",\n \"name\": \"Broken\",\n \"is_enabled\": 1,\n \"is_reverse_action\": 0\n },\n {\n \"id\": 3,\n \"slug\": \"in-service\",\n \"name\": \"In service\",\n \"is_enabled\": 1,\n \"is_reverse_action\": 0\n },\n {\n \"id\": 5,\n \"slug\": \"retired\",\n \"name\": \"Retired\",\n \"is_enabled\": 1,\n \"is_reverse_action\": 0\n }\n ],\n \"custom_fields\": [\n {\n \"custom_field_id\": 1,\n \"custom_field_slug\": \"custom-field-1\",\n \"custom_field_name\": \"Custom Field 1\",\n \"values\": [\n {\n \"value\": \"value-1\"\n },\n {\n \"value\": \"value-3\"\n }\n ]\n },\n {\n \"custom_field_id\": 2,\n \"custom_field_slug\": \"custom-field-2\",\n \"custom_field_name\": \"Custom Field 2\",\n \"values\": [\n {\n \"value\": \"This is a custom field...\"\n }\n ]\n },\n {\n \"custom_field_id\": 3,\n \"custom_field_slug\": \"custom-field-3\",\n \"custom_field_name\": \"Custom Field 3\",\n \"values\": [\n {\n \"value\": \"2024-01-20\"\n }\n ]\n }\n ],\n \"in_warranty\": true,\n \"users_count\": 1,\n \"cost_currency\": \"EUR\",\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n },\n \"asset_status\": {\n \"id\": 1,\n \"slug\": \"in-use\",\n \"name\": \"In use\",\n \"is_enabled\": 1\n },\n \"asset_category\": {\n \"id\": 5,\n \"name\": \"asset-category-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:04:03\",\n \"updated_at\": \"2023-11-16 09:32:03\",\n \"deleted_at\": null\n },\n \"employee_inventory_assignment\": {\n \"id\": 11,\n \"asset_id\": 9,\n \"employee_id\": 15,\n \"division_id\": 13,\n \"department_id\": 6,\n \"location_id\": 36,\n \"assign_date\": \"2024-02-13\",\n \"created_at\": \"2024-02-13 14:02:02\",\n \"updated_at\": \"2024-02-13 14:02:02\",\n \"deleted_at\": null,\n \"short_employee\": {\n \"employee_id\": 15,\n \"employee_name\": \"Doe John\",\n \"employee_number\": null,\n \"location_name\": \"Athens\",\n \"department_name\": \"Administration & Operations\",\n \"division_name\": \"Europe\",\n \"job_title_name\": \"Administrative Assistant\",\n \"linked_in_url\": null,\n \"work_phone\": \"698*******\",\n \"email\": \"john.doe@example.com\",\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/15_1700059591.jpg?Expires=1707996545&Signature=Sz5LpAEWiOTKE0YjsRCwh97kix5jizVMShMwijmblOItUjy51MOJcWj9yUWOo0bIqft7rH8ocNdRBZ6TPnPTRNRt6C-g2hBReYpiQ92QLw1YT9epeUqc39gTlS01JED2COnFlFxRXenVsR63kRq5m4xO8RlRfFT-m2iKVIci77RvTgc7AeSW-cEe0iHg90ljflyImnG0XDxNveX-ClWUnw6rSPYvKuOCB5GobNzPpw7eOUTzaQr2Jxyb0AAbgtskBPpQpUZRhN~Y7wo7DnNmXRfTuN4Ak207xaPJvq~xigeFa43DvSEmURY3bdTCMLdH98nbhiRfbae67QXML2OA8Q__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"is_me\": false\n },\n \"location\": {\n \"id\": 36,\n \"name\": \"Athens\"\n },\n \"division\": {\n \"id\": 13,\n \"name\": \"Europe\"\n },\n \"department\": {\n \"id\": 6,\n \"name\": \"Administration & Operations\"\n }\n }\n }\n}"},{"id":"500b9260-31f0-440f-afbb-71f670fdf8f5","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"asset_category_id\": \"\",\n \"cost_model\": \"\",\n \"serial_number\": \"\",\n \"label\": \"\",\n \"cost_frequency\": \"\",\n \"cost\": \"\",\n \"purchase_date\": \"\",\n \"warranty_end_date\": \"\",\n \"employee_id\": \"\",\n \"assign_date\": \"\",\n \"location_id\": \"\",\n \"division_id\": \"\",\n \"department_id\": \"\",\n \"description\": \"\",\n \"hr_family\": \"\",\n \"custom_field_01\": \"\",\n \"custom_field_02\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"b92274ec-046a-4e6f-b5e5-d476fe12f1f1"},{"name":"Get all assets categories of inventory type","id":"31cef34f-fe1c-4dc4-80fc-60f3a0775a69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories","description":"

API Endpoint to retrieve all the available categories for an inventory-type asset.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory","categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"363dc754-d175-4205-991c-ced6834f879b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"asset_type_id\": 2,\n \"name\\\"\": \"membership-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:28:26\",\n \"updated_at\": \"2023-11-16 13:03:57\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n }\n ]\n}"}],"_postman_id":"31cef34f-fe1c-4dc4-80fc-60f3a0775a69"},{"name":"Create a category for the inventory assets","id":"7ff4197b-4339-4995-abf5-07974e430e38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\" // (Required) The category name for the inventory asset. Maximum character limit: 191 characters.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories","description":"

API Endpoint to create a new category for the inventory assets.

\n

This endpoint facilitates the creation of a new inventory asset category. You should provide the name of the current category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringtrueThe category name for the inventory asset. Maximum character limit: 191 characters.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory","categories"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"cd959745-6a9d-4135-9d3e-a30e0100a130","name":"OK","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 1,\n \"asset_type_id\": 2,\n \"name\": \"membership-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2023-11-16 09:28:26\",\n \"updated_at\": \"2023-11-16 13:03:57\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n }\n}"},{"id":"52d3c913-4fdf-4e04-bbfc-7a9ea2389bbe","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"7ff4197b-4339-4995-abf5-07974e430e38"},{"name":"Get an inventory category","id":"bdfb6b3d-9451-4a41-a95c-c9141e637d16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","description":"

API Endpoint to retrieve the specified inventory category.

\n

This endpoint retrieves information for the specified inventory category.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory","categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"ba4c087c-2db6-456a-a90f-5e6dd50bc229","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"4360f718-c9ab-423c-846b-12c8558224a5","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"asset_type_id\": 1,\n \"name\": \"inventory-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2024-02-15 09:04:59\",\n \"updated_at\": \"2024-02-15 09:04:59\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n }\n }\n}"},{"id":"b13b88af-4736-4a30-b673-e383fee97fc8","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"bdfb6b3d-9451-4a41-a95c-c9141e637d16"},{"name":"Update an inventory category","id":"09cd6c48-1835-44b6-ab7f-e540fba09ab9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\", // Required without is_enabled. The category name for the inventory asset. Maximum character limit: 191 characters.\n \"is_enabled\": \"\" // Required without name. Choose 'true' to enable the invnetory category, and 'false' to disable it.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","description":"

API Endpoint to update the specified inventory category.

\n

This endpoint facilitates the modification for the specified inventory asset category. You should provide the name of the current category.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
namestringRequired without is_enabled.The category name for the inventory asset. Maximum character limit: 191 characters.-
is_enabledbooleanRequired without name.Choose 'true' to enable the invnetory category, and 'false' to disable it.-
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory","categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b788d5f7-a2ee-4e21-bd23-400082bcc1bf","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"cf6edfe6-6cab-44b1-ba36-924bfbed46a9","name":"OK","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"id\": 2,\n \"asset_type_id\": 1,\n \"name\": \"inventory-name\",\n \"is_enabled\": 1,\n \"created_at\": \"2024-02-15 09:04:59\",\n \"updated_at\": \"2024-02-15 09:04:59\",\n \"deleted_at\": null,\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n }\n }\n}"},{"id":"923f6e26-1023-4d7c-bcdf-b8d831f3364c","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"199d469f-5af6-400d-9420-894ecca55718","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"\",\n \"is_enabled\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"09cd6c48-1835-44b6-ab7f-e540fba09ab9"},{"name":"Delete a inventory category","id":"229935ec-26a6-42ee-98b0-910a5ec7cb0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","description":"

API Endpoint to delete the specified inventory category.

\n

This endpoint facilitates the deletion of the specified inventory category. If there are assets within this category the deletion cannot be done.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","inventory","categories",":objectId"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"60b75b92-4dea-428f-8fe4-8a6bf7515b36","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"dd91f473-c8fd-449b-a74f-997300e3feba","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"313b240f-c28c-46ed-816c-cf57be6b6476","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/inventory/categories/:objectId","host":["https://pubapi.talenthr.io/v1"],"path":["assets","inventory","categories",":objectId"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"229935ec-26a6-42ee-98b0-910a5ec7cb0e"},{"name":"Get asset's default values","id":"a393dc5c-609c-486d-b685-149e24b8c44d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/default-values","description":"

API Endpoint to get the default values for an asset.

\n

This endpoint retrieves comprehensive information on all default values an asset can have. This includes asset types, asset statuses, cost frequencies and cost models.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","default-values"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"28795a19-0a28-45c4-9ebf-5e40ec125a8f","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/default-values"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"asset_types\": [\n {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n },\n {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n }\n ],\n \"asset_statuses\": [\n {\n \"id\": 1,\n \"slug\": \"in-use\",\n \"name\": \"In use\"\n },\n {\n \"id\": 2,\n \"slug\": \"available\",\n \"name\": \"Available\"\n },\n {\n \"id\": 3,\n \"slug\": \"in-service\",\n \"name\": \"In service\"\n },\n {\n \"id\": 4,\n \"slug\": \"broken\",\n \"name\": \"Broken\"\n },\n {\n \"id\": 5,\n \"slug\": \"retired\",\n \"name\": \"Retired\"\n }\n ],\n \"cost_frequencies\": [\n {\n \"slug\": \"per-month\",\n \"name\": \"Per month\"\n },\n {\n \"slug\": \"per-year\",\n \"name\": \"Per year\"\n },\n {\n \"slug\": \"once-off\",\n \"name\": \"Once off\"\n }\n ],\n \"cost_models\": [\n {\n \"slug\": \"per-user\",\n \"name\": \"Per user\"\n },\n {\n \"slug\": \"per-company\",\n \"name\": \"Per company\"\n }\n ]\n }\n}"}],"_postman_id":"a393dc5c-609c-486d-b685-149e24b8c44d"},{"name":"Get asset's history","id":"2627ebe2-a542-4ae4-a0a0-42f192b7a7a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId/history?limit=&offset=","description":"

API Endpoint to get the changes that happened to the specified asset.

\n

This endpoint retrieves comprehensive information on assets' history. You can check either a membership asset history or an inventory one. You have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage).

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","history"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""}],"variable":[{"id":"153ff83d-9306-4794-aa0f-f8906af5dddf","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"82ff9e47-0d7b-480f-9a9e-26ba077eaa18","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/history?limit=&offset=","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","history"],"query":[{"key":"limit","value":""},{"key":"offset","value":""}],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 49,\n \"asset_id\": 14,\n \"field\": null,\n \"event_type_id\": 6,\n \"event_target\": \"EmployeeAssetsAssignment\",\n \"event_data\": {\n \"asset_id\": 14,\n \"actor_name\": \"Mia Black\",\n \"asset_name\": \"asset-name\",\n \"asset_type\": \"inventory\",\n \"subject_id\": \"15\",\n \"actor_email\": \"karras+1@openit.gr\",\n \"assign_date\": \"2024-02-14\",\n \"subject_name\": \"Doe John\",\n \"assignee_name\": \"Doe John\"\n },\n \"created_at\": \"2024-02-14 16:09:24\",\n \"text\": \"asset-name assigned to employee Doe John (assign date: Feb 14, 2024).\"\n }\n ]\n }\n}"},{"id":"ec57fbcb-8d06-412a-94f9-8116ea1bb8fe","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/history?limit=&offset=","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","history"],"query":[{"key":"limit","value":""},{"key":"offset","value":""}],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"2627ebe2-a542-4ae4-a0a0-42f192b7a7a1"},{"name":"Update an asset status","id":"18f38c14-30a5-4b54-9b85-ba48ca8e5987","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_status_slug\": \"\" // (Required) The slug of the asset status. If the asset type is \"membership\", the available actions are limited to \"available\" and \"retired\". However, if the type is \"inventory\", the available options expand to include [available, in-use, in-service, broken, retired]. For an inventory asset with an assigned user, transitioning to the \"in-use\" status is applicable primarily when the current status is \"broken\" or \"in-service\". When the status is \"retired\", the assigned user is no longer associated, thus preventing a transition to the \"in-use\" status.\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/:objectId/change-status","description":"

API Endpoint to change the status of the specified asset.

\n

This endpoint allows for the modification of an asset's status, applicable to both inventory and membership assets, with each type having its distinct set of statuses.

\n

For membership assets, there are only two possible statuses:

\n
    \n
  • Available: Indicates the asset is ready and accessible for use.
    • \n
  • Retired: Signifies that the asset is no longer in service or use.
    • \n
\n

Inventory assets, on the other hand, have a broader range of five possible statuses:

\n
    \n
  • Available: The asset is not currently being used and is ready for deployment.
    • \n
  • In Use: Indicates the asset is actively being utilized.
    • \n
  • In Service: The asset is undergoing maintenance or repairs.
    • \n
  • Broken: The asset is damaged and not in working condition.
    • \n
  • Retired: Similar to the membership asset, this status means the asset is no longer in service.
    • \n
\n

For inventory assets with an assigned user, the transition to the \"In Use\" status is specifically relevant when the asset is moving from a \"Broken\" or \"In Service\" status. It is important to note that once an inventory asset is marked as \"Retired,\" any association with an assigned user is removed, effectively preventing any further transition to the \"In Use\" status.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
asset_status_slugenumtrueThe slug of the asset status. If the asset type is \"membership\", the available actions are limited to \"available\" and \"retired\". However, if the type is \"inventory\", the available options expand to include [available, in-use, in-service, broken, retired]. For an inventory asset with an assigned user, transitioning to the \"in-use\" status is applicable primarily when the current status is \"broken\" or \"in-service\". When the status is \"retired\", the assigned user is no longer associated, thus preventing a transition to the \"in-use\" status.in-use, available, in-service, broken, retired
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","change-status"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"cbda1717-d37c-485d-9899-9bf9c71e047f","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"2244c956-f867-44d4-b43e-2b8b7f6d4a91","name":"Simple boolean response","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_status_slug\": \"in-service\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/change-status","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","change-status"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"9075d1e0-8eb8-48e1-98b8-6eba96f03d5e","name":"Not found exception (404)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_status_slug\": \"in-service\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/change-status","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","change-status"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"ed796dad-ccab-4707-9301-ae2bd99d6ac4","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"PUT","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asset_status_slug\": \"in-service\"\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/change-status","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","change-status"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"18f38c14-30a5-4b54-9b85-ba48ca8e5987"},{"name":"Get asset's employees","id":"c7ba69bd-7e2b-490b-90f4-58a539cc6a6e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId/employees?limit=&offset=&order=&sort=&search=","description":"

API Endpoint to retrieve the employees that have been assigned this asset.

\n

This endpoint retrieves comprehensive information regarding the employees assigned to an asset. Users have the flexibility to customize the data retrieval process through a pagination mechanism. (Refer to the Introductory chapter for further details on usage). In addition to pagination parameters, users can customize the order and sorting of the retrieved data or search through them. The search option can filter employees based on their first name, last name, location, division, department, job title.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","employees"],"host":["https://pubapi.talenthr.io/v1"],"query":[{"description":{"content":"

Pagination limit

\n","type":"text/plain"},"key":"limit","value":""},{"description":{"content":"

Pagination's offset (In case of '-1', then pagination is off)

\n","type":"text/plain"},"key":"offset","value":""},{"description":{"content":"

Pagination's orderBy. Enum value ['asc', 'desc']

\n","type":"text/plain"},"key":"order","value":""},{"description":{"content":"

Pagination's sort. Enum value ['assign_date', 'name', 'location', 'department', 'division']

\n","type":"text/plain"},"key":"sort","value":""},{"description":{"content":"

Searching

\n","type":"text/plain"},"key":"search","value":""}],"variable":[{"id":"a1e6aa06-baa6-4c50-87e7-2f35d9ed82fa","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"c86359ee-f19a-4203-ad20-f3a3cf94cd75","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/employees?limit=&offset=&order=&sort=&search=","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","employees"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""}],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": {\n \"total\": 1,\n \"rows\": [\n {\n \"id\": 15,\n \"user_id\": 15,\n \"reports_to_employee_id\": 1,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/testdomain1/avatars/15_1700059591.jpg?Expires=1708502351&Signature=alQJQfgZDB2gUid0UcSz2DP2GfkH8jf~~uImvwplPEBr4JOFEYevXYVr563m5KwLJhau3NB5grzAnt3ES~~c64jJ2QcTFSpOIpcZkj6fXcrsXaKJHVisd9CZtyKnxQJ0RTUvrpIGAje0TJGSEi0UWIUTRa7jMEPBWSMmNjv0hyxnCp5d9HxSSJiTka83iwXrEVwsp2msEX~jSBttm7w-uDLUeOoOwZEcKXZp-GURKs69yTK9Tm6HESCtZuxXAPVVnRYQIbq87OMOz01~bpB8nsoKoLpz2qz4AZf5O6o3mHTg5n4XGWnhz3e9hZh5fw-ENih3iIp8WF9Cd2mMSjy6OQ__&Key-Pair-Id=K2KPAB7VLWPOH\",\n \"u_id\": 15,\n \"first_name\": \"Doe\",\n \"last_name\": \"John\",\n \"email\": \"john.doe@example.com\",\n \"division_id\": 13,\n \"division\": \"Europe\",\n \"department_id\": 6,\n \"department\": \"Administration & Operations\",\n \"location_id\": 36,\n \"location\": \"Athens\",\n \"job_title_id\": 25,\n \"job_title\": \"Administrative Assistant\",\n \"assign_date\": \"2024-02-14\"\n }\n ]\n }\n}"},{"id":"2b442d7e-921f-43ee-9001-c9fe5edcebdf","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/employees?limit=&offset=&order=&sort=&search=","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","employees"],"query":[{"key":"limit","value":""},{"key":"offset","value":""},{"key":"order","value":""},{"key":"sort","value":""},{"key":"search","value":""}],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"c7ba69bd-7e2b-490b-90f4-58a539cc6a6e"},{"name":"Get asset's custom fields","id":"6ed5dfef-36bc-4715-bea2-89225bc1aac0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId/custom-fields","description":"

API Endpoint to get the custom fields that are available for an asset.

\n

This endpoint is designed to fetch the custom fields associated with a specified asset, as well as the values of these custom fields.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","custom-fields"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"23740c5f-3e41-44e4-bd79-274fb4c7e463","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"8a3e0709-4763-4447-bb06-d9778905b714","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/custom-fields","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","custom-fields"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Custom Field 1\",\n \"slug\": \"custom-field-1\",\n \"custom_field_type_id\": 4,\n \"asset_type_id\": null,\n \"subfields\": 0,\n \"is_predefined\": false,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": null,\n \"visible_to\": \"all\",\n \"has_multiple_records\": false,\n \"created_at\": \"2024-02-14 08:51:13\",\n \"updated_at\": \"2024-02-14 08:51:13\",\n \"deleted_at\": null,\n \"field_name\": \"custom-field-1\",\n \"custom_field_type\": {\n \"id\": 4,\n \"slug\": \"multiple-choice\",\n \"name\": \"Multiple choice\"\n },\n \"asset_custom_field_values\": [\n {\n \"id\": 1,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 1\"\n },\n {\n \"id\": 2,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 2\"\n },\n {\n \"id\": 3,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 3\"\n },\n {\n \"id\": 4,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 4\"\n }\n ],\n \"asset_type\": null\n }\n ]\n}"},{"id":"bb6dab5b-c56f-466e-a7f2-595341094f92","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/custom-fields","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","custom-fields"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"6ed5dfef-36bc-4715-bea2-89225bc1aac0"},{"name":"Get the available employees","id":"ccb587e9-55ef-43ce-99cb-baed63ba7d49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId/available-employees","description":"

API Endpoint to retrieve the available employees for the specified asset.

\n

This endpoint is designed to retrieve detailed information about all the employees available within the domain for assignment to a specific asset. If there are employees already assigned to the asset (or a single employee in the case of an inventory asset), the response will exclude those employees, thus providing a list of all other domain employees who are available for assignment.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","available-employees"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b643f654-b7fa-449e-a4c3-43ef62806c5a","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"92c4cebf-0e1c-476e-b8a8-4f5ffd9eeb53","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/available-employees","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","available-employees"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 19,\n \"user_id\": 19,\n \"reports_to_employee_id\": 1,\n \"photo_url\": \"https://d2spisfw2i7npf.cloudfront.net/public-assets/people/default-avatar.png...\",\n \"u_id\": 19,\n \"first_name\": \"Clive\",\n \"last_name\": \"Bixby\",\n \"email\": \"karras+5@openit.gr\",\n \"division_id\": 13,\n \"division\": \"Europe\",\n \"department_id\": 6,\n \"department\": \"Administration & Operations\",\n \"location_id\": 36,\n \"location\": \"Athens\",\n \"job_title_id\": 26,\n \"job_title\": \"Business Analyst\",\n \"is_me\": 0\n }\n ]\n}"},{"id":"6c599294-627a-4192-943d-a52552ea2f95","name":"Not found exception (404)","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/available-employees","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","available-employees"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"ccb587e9-55ef-43ce-99cb-baed63ba7d49"},{"name":"Assign employees to a Membership Asset","id":"54d8d098-36e8-4266-a750-8f0465553eab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employees\": [ // (Required) Array with Employees' Ids (Active Employees). Exclude employees that already are assigned to this asset. The array contains the IDs of employees to whom the asset will be assigned. It is not allowed to assign employees to an inventory asset or if asset is retired.\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://pubapi.talenthr.io/v1/assets/:objectId/assign-employees","description":"

API Endpoint to assign employees to a Membership Asset.

\n

This endpoint facilitates to assign employees to a membership asset, with the system automatically excluding any employees who are already assigned to the specified asset. It's important to note that this functionality is exclusive to membership assets; assigning employees to an inventory asset through this endpoint is not permitted. Additionally, if the asset is marked as \"retired,\" the assignment of employees is also disallowed.

\n

Request body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameTypeRequiredDescriptionValues
employeesarraytrueThe array contains the IDs (Active employess) of employees to whom the asset will be assigned. Exclude employees that already are assigned to this asset. It is not allowed to assign employees to an inventory asset or if asset is retired.e.g. \"employees\":[1,2]
\n
","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","assign-employees"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"b39280cd-adbd-429f-9398-80ffd6453115","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"}]}},"response":[{"id":"2678994b-0e55-402a-903b-e4cb94d4cf74","name":"Simple boolean response","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employees\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/assign-employees","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","assign-employees"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"aa1184f1-aeeb-4a64-91f4-ca12a516954c","name":"Not found exception (404)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employees\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/assign-employees","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","assign-employees"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"},{"id":"d30fd735-b690-40b8-95db-973b96c384a1","name":"Unprocessable Entity / Validation Exception (422)","originalRequest":{"method":"POST","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"employees\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/assign-employees","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","assign-employees"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The field_1 field is required. (and 1 more error)\",\n \"hr_code\": 10\n },\n \"attempts\": 0,\n \"errors\": {\n \"field_1\": [\n \"The field_1 field is required.\"\n ],\n \"field_2\": [\n \"The field_2 must be an integer.\"\n ]\n }\n}"}],"_postman_id":"54d8d098-36e8-4266-a750-8f0465553eab"},{"name":"Remove an asset from an employee","id":"4e99b1e9-04ab-4681-9e81-36ad12d8979a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"https://pubapi.talenthr.io/v1/assets/:objectId/employees/:employee","description":"

API Endpoint to remove an asset from an employee.

\n

This endpoint enables the disassociation of an asset from a specified employee. Specifically, if the asset being removed is an inventory asset, its status will automatically be updated from 'in-use' to 'available'.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets",":objectId","employees",":employee"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[{"id":"a7155ee3-f264-44a6-840d-446b8004c420","description":{"content":"

(Required) The related object id

\n","type":"text/plain"},"type":"any","value":"","key":"objectId"},{"id":"535b1fb4-76b4-4d56-a3d5-d49a15006a87","description":{"content":"

(Required) The id of the employee

\n","type":"text/plain"},"type":"any","value":"","key":"employee"}]}},"response":[{"id":"74174c59-c33d-4442-b1f1-b715565eb582","name":"Simple boolean response","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","employees",":employee"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"},{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true\n}"},{"id":"264d65c2-b036-4c83-99a7-49c27717202e","name":"Not found exception (404)","originalRequest":{"method":"DELETE","header":[{"description":"Added as a part of security scheme: basic","key":"Authorization","value":"Basic "},{"key":"Accept","value":"application/json"}],"url":{"raw":"https://pubapi.talenthr.io/v1/assets/:objectId/employees/:employee","host":["https://pubapi.talenthr.io/v1"],"path":["assets",":objectId","employees",":employee"],"variable":[{"key":"objectId","value":"","description":"(Required) The related object id"},{"key":"employee","value":"","description":"(Required) The id of the employee"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"error\": {\n \"message\": \"The error message...\",\n \"code\": 404,\n \"hr_code\": 41,\n \"hr_code_key\": \"not_found_http\",\n \"dev\": {\n \"file\": \"/usr/local/apache2/htdocs/www/vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php\",\n \"line\": 391,\n \"exception_class\": \"Symfony\\\\Component\\\\HttpKernel\\\\Exception\\\\NotFoundHttpException\"\n }\n }\n}"}],"_postman_id":"4e99b1e9-04ab-4681-9e81-36ad12d8979a"},{"name":"Get all assets custom fields","id":"23de7e1f-a607-452b-9f33-619006f79a10","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://pubapi.talenthr.io/v1/assets/custom-fields","description":"

This endpoint retrieves comprehensive information on enabled asset custom fields. It provides details on the status of the asset custom field as well as info for the type of custom field, and, in cases where the field is configured for single or multiple-choice options, any values associated with these choices.

\n

You can identify the scope of an asset custom field based on the asset_type_id. If this identifier is null, the asset is universally applicable to all asset types (membership and inventory). Otherwise, if the ID of a specific asset is provided, the applicability of the asset is limited to that asset type.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}},"urlObject":{"path":["assets","custom-fields"],"host":["https://pubapi.talenthr.io/v1"],"query":[],"variable":[]}},"response":[{"id":"698588aa-5d11-4bc4-b035-4586d2952acd","name":"OK","originalRequest":{"method":"GET","header":[],"url":"https://pubapi.talenthr.io/v1/assets/custom-fields"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"data\": [\n {\n \"id\": 1,\n \"name\": \"Custom Field 1\",\n \"slug\": \"custom-field-1\",\n \"custom_field_type_id\": 4,\n \"asset_type_id\": 1,\n \"subfields\": 0,\n \"is_predefined\": false,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": null,\n \"visible_to\": \"all\",\n \"has_multiple_records\": false,\n \"created_at\": \"2024-02-14 08:51:13\",\n \"updated_at\": \"2024-04-01 10:57:09\",\n \"deleted_at\": null,\n \"field_name\": \"custom-field-1\",\n \"asset_type\": {\n \"id\": 1,\n \"slug\": \"inventory\",\n \"name\": \"Inventory\"\n },\n \"custom_field_type\": {\n \"id\": 4,\n \"slug\": \"multiple-choice\",\n \"name\": \"Multiple choice\"\n },\n \"asset_custom_field_values\": [\n {\n \"id\": 1,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 1\"\n },\n {\n \"id\": 2,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 2\"\n },\n {\n \"id\": 3,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 3\"\n },\n {\n \"id\": 4,\n \"asset_custom_field_id\": 1,\n \"name\": \"Option 4\"\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"Custom Field 2\",\n \"slug\": \"custom-field-2\",\n \"custom_field_type_id\": 2,\n \"asset_type_id\": 2,\n \"subfields\": 0,\n \"is_predefined\": false,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": null,\n \"visible_to\": \"all\",\n \"has_multiple_records\": false,\n \"created_at\": \"2024-02-14 08:53:29\",\n \"updated_at\": \"2024-04-01 10:58:10\",\n \"deleted_at\": null,\n \"field_name\": \"custom-field-2\",\n \"asset_type\": {\n \"id\": 2,\n \"slug\": \"subscription\",\n \"name\": \"Membership\"\n },\n \"custom_field_type\": {\n \"id\": 2,\n \"slug\": \"long-text-field\",\n \"name\": \"Long text field\"\n },\n \"asset_custom_field_values\": []\n },\n {\n \"id\": 3,\n \"name\": \"Custom Field 3\",\n \"slug\": \"custom-field-3\",\n \"custom_field_type_id\": 6,\n \"asset_type_id\": null,\n \"subfields\": 0,\n \"is_predefined\": false,\n \"is_enabled\": true,\n \"is_group\": false,\n \"parent_group_id\": null,\n \"visible_to\": \"all\",\n \"has_multiple_records\": false,\n \"created_at\": \"2024-02-14 08:53:42\",\n \"updated_at\": \"2024-02-14 08:53:42\",\n \"deleted_at\": null,\n \"field_name\": \"custom-field-3\",\n \"asset_type\": null,\n \"custom_field_type\": {\n \"id\": 6,\n \"slug\": \"date\",\n \"name\": \"Date\"\n },\n \"asset_custom_field_values\": []\n }\n ]\n}"}],"_postman_id":"23de7e1f-a607-452b-9f33-619006f79a10"}],"id":"12ddbfe3-6627-454d-850f-754e3c0f88c7","description":"

To use this feature requires that your subscription for TalentHR supports the respective component.

\n","_postman_id":"12ddbfe3-6627-454d-850f-754e3c0f88c7","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":true,"source":{"_postman_id":"39f4121a-d6e2-48c3-a941-0c031292b69c","id":"39f4121a-d6e2-48c3-a941-0c031292b69c","name":"TalentHR API","type":"collection"}}}],"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"2e40fc4d-23a9-4b38-a515-e5fea3c2e1fc","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"c8dbc629-d721-4bf0-9002-beffed15342a","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"https://pubapi.talenthr.io/v1","type":"string"},{"key":"basicAuthUsername","value":"","type":"string"},{"key":"basicAuthPassword","value":"","type":"string"}]}