Query structured spec data via REST or MCP. Get exactly what your agent needs.
https://subdomain.sage.hr/api
/documents
Document will only be visible to employee themselves
{
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/DocumentsCreateNewDocumentRequest"
}
}
},
"required": true
}
POST /documents
/documents/categories
GET /documents/categories
/employees
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer | |
| team_history | query | optional | boolean | |
| employment_status_history | query | optional | boolean | |
| position_history | query | optional | boolean |
GET /employees
/employees
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/EmployeeCreateNewEmployeeRequest"
}
}
},
"required": true
}
POST /employees
/employees/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user to get. |
| team_history | query | optional | boolean | |
| employment_status_history | query | optional | boolean | |
| position_history | query | optional | boolean |
GET /employees/{id}
/employees/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user to update. |
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmployeeUpdateByIdRequest"
}
}
}
}
PUT /employees/{id}
/employees/{id}/compensations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user to get. |
GET /employees/{id}/compensations
/employees/{id}/custom-fields
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user to get. |
GET /employees/{id}/custom-fields
/employees/{id}/custom-fields/{custom_field_id}
Update employee custom field
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Employee identifier |
| custom_field_id | path | required | integer | Custom field identifier |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/EmployeeUpdateCustomFieldRequest"
}
}
},
"required": true
}
PUT /employees/{id}/custom-fields/{custom_field_id}
/employees/{id}/terminations
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/EmployeeTerminateEmployeeRequest"
}
}
},
"required": true
}
POST /employees/{id}/terminations
/terminated-employees
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer |
GET /terminated-employees
/terminated-employees/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user to get. |
GET /terminated-employees/{id}
/vikarina/appointments
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/appointments
/vikarina/bank-accounts
POST /vikarina/bank-accounts
/vikarina/bonuses
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/bonuses
/vikarina/contract-information
POST /vikarina/contract-information
/vikarina/job-positions
POST /vikarina/job-positions
/vikarina/leave-types
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/leave-types
/vikarina/newstarter-employees
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/newstarter-employees
/vikarina/organization-structure
POST /vikarina/organization-structure
/vikarina/salaries
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/salaries
/vikarina/terminated-employees
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/terminated-employees
/vikarina/timesheets
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| start_date | query | optional | string | |
| end_date | query | optional | string |
POST /vikarina/timesheets
/vikarina/unused-days
POST /vikarina/unused-days
/leave-management/out-of-office-today
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| date | query | optional | string | Optional date, defauls to today |
GET /leave-management/out-of-office-today
/leave-management/policies
GET /leave-management/policies
/leave-management/policies/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the policy to get. |
GET /leave-management/policies/{id}
/leave-management/reports/individual-allowances
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer | |
| per_page | query | optional | integer | |
| location_ids | query | optional | array | Limit the reports to employees in specified location ids |
| employee_ids | query | optional | array | Limit the reports to selected employee ids |
| team_ids | query | optional | array | Limit the reports to employees in specified team ids |
GET /leave-management/reports/individual-allowances
/leave-management/requests
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer | |
| from | query | optional | string | If not specified defaults to beginning of current month |
| to | query | optional | string | If not specified defaults to end of current month. Days between from date and to date must be less than 65. If you need info for larger period of time make multiple requests; |
GET /leave-management/requests
/leave-management/requests
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/LeaveManagementNewTimeOffRequestRequest"
}
}
},
"required": true
}
POST /leave-management/requests
/employees/{id}/leave-management/balances
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the user to get. |
GET /employees/{id}/leave-management/balances
/leave-management/policies/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of the policy to get. |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/LeaveManagementUpdateKitDaysConfigurationRequest"
}
}
},
"required": true
}
PATCH /leave-management/policies/{id}
/leave-management/kit-days
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| policy_id | query | required | integer | Time-off policy identifier |
| employee_id | query | required | integer | Employee identifier |
GET /leave-management/kit-days
/leave-management/kit-days
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/LeaveManagementCreateKitDayRequest"
}
}
},
"required": true
}
POST /leave-management/kit-days
/leave-management/kit-days/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | KIT day identifier |
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/LeaveManagementProcessKitDayRequest"
}
}
},
"required": true
}
PATCH /leave-management/kit-days/{id}
/offboarding/categories
GET /offboarding/categories
/offboarding/tasks
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OffboardingCreateTaskRequest"
}
}
},
"required": true
}
POST /offboarding/tasks
/onboarding/categories
GET /onboarding/categories
/onboarding/tasks
{
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/OnboardingCreateNewTaskRequest"
}
}
},
"required": true
}
POST /onboarding/tasks
/performance/goals/quarterly-progress/company-goals
GET /performance/goals/quarterly-progress/company-goals
/performance/goals/quarterly-progress/individual-goals
GET /performance/goals/quarterly-progress/individual-goals
/performance/goals/quarterly-progress/overall
GET /performance/goals/quarterly-progress/overall
/performance/goals/quarterly-progress/team-goals
GET /performance/goals/quarterly-progress/team-goals
/positions
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer |
GET /positions
/recruitment/applicants/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of applicant |
GET /recruitment/applicants/{id}
/recruitment/applicants/{id}/actions
List applicant's process throught the recruitment pipeline. Newest, first.
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of applicant |
| page | query | optional | integer | Pagination: fetch page at given offset |
| per_page | query | optional | integer | Pagination: amount of actions to return in 1 call, default: 30, max: 100 |
GET /recruitment/applicants/{id}/actions
/recruitment/positions
Posible recruitment position statuses: `draft`, `published`, `internal`, `completed`, `cancelled`
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| status | query | optional | string | Filter by status, see list of possible statuses `?status=open` |
| hiring_manager_ids | query | optional | array | Filter by hiring manager id, can appear multiple times `hiring_manager_ids[]=251&hiring_manager_ids[]=121` |
| group_ids | query | optional | array | Filter by group id, can appear multiple times `group_ids[]=27&group_ids[]=761` |
| location_ids | query | optional | array | Filter by location id, can appear multiple times `location_ids[]=1&location_ids[]=12` |
| page | query | optional | integer | Pagination: fetch page at given offset |
| per_page | query | optional | integer | Pagination: amount of positions to return in 1 call, default: 30, max: 100 |
GET /recruitment/positions
/recruitment/positions/{id}
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of position |
GET /recruitment/positions/{id}
/recruitment/positions/{id}/applicants
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of position |
| stage_id | query | optional | integer | Optional filter by stage e.g. `?stage_id=25` |
| page | query | optional | integer | Pagination: fetch page at given offset, default 1 |
| per_page | query | optional | integer | Pagination: amount of applicants to return in 1 call, default: 30, max: 100 |
GET /recruitment/positions/{id}/applicants
/recruitment/positions/{id}/applicants
Tracking applicant's source: * if left blank, source will be automatically set to `api` * set source to a special keyword (`company_marketing`, `recruiters`, `referral`, `sourced`) to have it mapped to corresponding values * set source to a desired reference to create a custom source, e.g. `source=linkedin` will create a custom source called linkedin if it does not exist already * passing a referral object as a parameter will set the source to `referral` Example of creating an applicant with a refferal object: ``` curl -X POST -H 'X-AUTH-TOKEN:***' -H 'Content-Type:application/json' \ "https://***/api/recruitment/positions/2/applicants" \ -d '{"applicant": \ {"referral": {"email": "recruitment@example.com", "full_name": "Alice L"}, \ "address": "BD23 8UL", "summary":"An applicant", \ "first_name": "Applicant Name"}}' ```
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| id | path | required | integer | Numeric ID of position (must not be closed or completed). |
{
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/RecruitmentCreateApplicantWithReferralRequest"
}
}
}
}
POST /recruitment/positions/{id}/applicants
/teams
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer |
GET /teams
/termination-reasons
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| page | query | optional | integer |
GET /termination-reasons
/timesheets/clock-in
Employees will be only clocked in & out if API time clocking is enabled for Timesheet group
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TimesheetsClockInOutRequest"
}
}
},
"required": true,
"description": "Times on specific dates for specific employees as json"
}
POST /timesheets/clock-in
DocumentsCreateNewDocumentRequest
{
"type": "object",
"required": [
"file",
"employee_id"
],
"properties": {
"file": {
"type": "string",
"format": "binary",
"description": "The file to upload."
},
"notify": {
"type": "string",
"description": "'true' to notify employee by email"
},
"category_id": {
"type": "integer",
"description": "Category identifier, leave empty for default category"
},
"description": {
"type": "string",
"description": "Document description"
},
"employee_id": {
"type": "integer",
"description": "Employee identifier"
}
}
}
DocumentsCreateNewDocumentResponse
{
"type": "object",
"example": {
"data": {
"id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
DocumentsListCategoriesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"name": "General",
"documents_count": 10
},
{
"id": 2,
"name": "Job contracts",
"documents_count": 1
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "General"
},
"documents_count": {
"type": "number",
"example": 10
}
}
}
}
}
}
EmployeeCreateNewEmployeeRequest
{
"type": "object",
"required": [
"email",
"first_name",
"last_name"
],
"properties": {
"email": {
"type": "string",
"description": "Employees email"
},
"last_name": {
"type": "string",
"description": "Employees last name"
},
"first_name": {
"type": "string",
"description": "Employees first name"
},
"send_email": {
"type": "string",
"description": "'true' to send welcome email to employee"
},
"work_start_date": {
"type": "string",
"description": "Employees work start date, format: YYYY-MM-DD, leave empty to use todays date"
}
}
}
EmployeeCreateNewEmployeeResponse
{
"type": "object",
"example": {
"data": {
"id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
EmployeeGetByIdResponse
{
"type": "object",
"example": {
"data": {
"id": 19,
"city": "London",
"team": "Sage HR",
"email": "john@example.com",
"gender": "Male",
"country": "GB",
"team_id": 6742,
"position": "Api developer",
"last_name": "Doe",
"post_code": 99999,
"first_name": "John",
"home_phone": "555-0506",
"work_phone": "555-0505",
"picture_url": "https://example.com/john.png",
"position_id": 123,
"mobile_phone": "555-0507",
"street_first": "84 Glenwood Street",
"team_history": [
{
"team_id": 1,
"end_date": "201-01-01",
"team_name": "Some Team",
"start_date": "2018-01-01"
}
],
"date_of_birth": "1991-02-13",
"street_second": "Peoria",
"employee_number": "A1",
"position_history": [
{
"end_date": "201-01-01",
"start_date": "2018-01-01",
"position_id": 1,
"position_code": "1234",
"position_name": "Developer"
}
],
"employment_status": "Full-time",
"employment_start_date": "2014-08-25",
"reports_to_employee_id": 5,
"employment_status_history": [
{
"end_date": "201-01-01",
"start_date": "2018-01-01",
"employment_status_id": 1,
"employment_statu_name": "Full time"
}
]
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"city": {
"type": "string",
"example": "London"
},
"team": {
"type": "string",
"example": "Sage HR"
},
"email": {
"type": "string",
"example": "john@example.com"
},
"gender": {
"type": "string",
"example": "Male"
},
"country": {
"type": "string",
"example": "GB"
},
"team_id": {
"type": "number",
"example": 6742
},
"position": {
"type": "string",
"example": "Api developer"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"post_code": {
"type": "number",
"example": 99999
},
"first_name": {
"type": "string",
"example": "John"
},
"home_phone": {
"type": "string",
"example": "555-0506"
},
"work_phone": {
"type": "string",
"example": "555-0505"
},
"picture_url": {
"type": "string",
"example": "https://example.com/john.png"
},
"position_id": {
"type": "number",
"example": 123
},
"mobile_phone": {
"type": "string",
"example": "555-0507"
},
"street_first": {
"type": "string",
"example": "84 Glenwood Street"
},
"team_history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"team_id": {
"type": "number",
"example": 1
},
"end_date": {
"type": "string",
"example": "201-01-01"
},
"team_name": {
"type": "string",
"example": "Some Team"
},
"start_date": {
"type": "string",
"example": "2018-01-01"
}
}
}
},
"date_of_birth": {
"type": "string",
"example": "1991-02-13"
},
"street_second": {
"type": "string",
"example": "Peoria"
},
"employee_number": {
"type": "string",
"example": "A1"
},
"position_history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"example": "201-01-01"
},
"start_date": {
"type": "string",
"example": "2018-01-01"
},
"position_id": {
"type": "number",
"example": 1
},
"position_code": {
"type": "string",
"example": "1234"
},
"position_name": {
"type": "string",
"example": "Developer"
}
}
}
},
"employment_status": {
"type": "string",
"example": "Full-time"
},
"employment_start_date": {
"type": "string",
"example": "2014-08-25"
},
"reports_to_employee_id": {
"type": "number",
"example": 5
},
"employment_status_history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"example": "201-01-01"
},
"start_date": {
"type": "string",
"example": "2018-01-01"
},
"employment_status_id": {
"type": "number",
"example": 1
},
"employment_statu_name": {
"type": "string",
"example": "Full time"
}
}
}
}
}
}
}
}
EmployeeGetCompensationsResponse
{
"type": "object",
"example": {
"data": [
{
"amount": 1234,
"period": "monthly",
"comment": "Starting salary",
"category": "Salary",
"currency": "EUR",
"end_date": "2019-01-01",
"start_date": "2017-01-01"
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number",
"example": 1234
},
"period": {
"type": "string",
"example": "monthly"
},
"comment": {
"type": "string",
"example": "Starting salary"
},
"category": {
"type": "string",
"example": "Salary"
},
"currency": {
"type": "string",
"example": "EUR"
},
"end_date": {
"type": "string",
"example": "2019-01-01"
},
"start_date": {
"type": "string",
"example": "2017-01-01"
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
EmployeeGetCustomFieldsResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"type": "CustomDropdownField",
"label": "Hobby",
"value": "Hockey",
"options": [
"Hockey",
"Football",
"Voleyball"
]
},
{
"id": 2,
"type": "CustomTags",
"label": "Languages",
"value": [
"English",
"Latvian",
"Estonian"
],
"options": null
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"type": {
"type": "string",
"example": "CustomDropdownField"
},
"label": {
"type": "string",
"example": "Hobby"
},
"value": {
"oneOf": [
{
"type": "string",
"example": "Hockey"
},
{
"type": "array",
"items": {
"type": "string",
"example": "English"
}
}
]
},
"options": {
"type": "array",
"items": {
"type": "string",
"example": "Hockey"
},
"nullable": true
}
}
}
}
}
}
EmployeeGetTerminatedEmployeeResponse
{
"type": "object",
"example": {
"data": {
"id": 19,
"email": "john@example.com",
"position": "Api developer",
"last_name": "Doe",
"first_name": "John",
"picture_url": "https://example.com/john.png",
"termination": {
"reason": "Moving location",
"comments": "Moving to"
},
"date_of_birth": "1991-02-13",
"termination_date": "2015-05-28",
"employment_start_date": "2014-08-25"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"email": {
"type": "string",
"example": "john@example.com"
},
"position": {
"type": "string",
"example": "Api developer"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"first_name": {
"type": "string",
"example": "John"
},
"picture_url": {
"type": "string",
"example": "https://example.com/john.png"
},
"termination": {
"type": "object",
"properties": {
"reason": {
"type": "string",
"example": "Moving location"
},
"comments": {
"type": "string",
"example": "Moving to"
}
}
},
"date_of_birth": {
"type": "string",
"example": "1991-02-13"
},
"termination_date": {
"type": "string",
"example": "2015-05-28"
},
"employment_start_date": {
"type": "string",
"example": "2014-08-25"
}
}
}
}
}
EmployeeListActiveEmployeesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 19,
"city": "London",
"team": "Sage HR",
"email": "john@example.com",
"gender": "Male",
"country": "GB",
"team_id": 1,
"position": "Api developer",
"last_name": "Doe",
"post_code": 99999,
"first_name": "John",
"home_phone": "555-0506",
"work_phone": "555-0505",
"picture_url": "https://example.com/john.png",
"position_id": 123,
"mobile_phone": "555-0507",
"street_first": "84 Glenwood Street",
"team_history": [
{
"team_id": 1,
"end_date": "201-01-01",
"team_name": "Some Team",
"start_date": "2018-01-01"
}
],
"date_of_birth": "1991-02-13",
"street_second": "Peoria",
"employee_number": "A01",
"position_history": [
{
"end_date": "201-01-01",
"start_date": "2018-01-01",
"position_id": 1,
"position_code": "1234",
"position_name": "Developer"
}
],
"employment_status": "Full-time",
"employment_start_date": "2014-08-25",
"reports_to_employee_id": 5,
"employment_status_history": [
{
"end_date": "201-01-01",
"start_date": "2018-01-01",
"employment_status_id": 1,
"employment_statu_name": "Full time"
}
]
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"city": {
"type": "string",
"example": "London"
},
"team": {
"type": "string",
"example": "Sage HR"
},
"email": {
"type": "string",
"example": "john@example.com"
},
"gender": {
"type": "string",
"example": "Male"
},
"country": {
"type": "string",
"example": "GB"
},
"team_id": {
"type": "number",
"example": 1
},
"position": {
"type": "string",
"example": "Api developer"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"post_code": {
"type": "number",
"example": 99999
},
"first_name": {
"type": "string",
"example": "John"
},
"home_phone": {
"type": "string",
"example": "555-0506"
},
"work_phone": {
"type": "string",
"example": "555-0505"
},
"picture_url": {
"type": "string",
"example": "https://example.com/john.png"
},
"position_id": {
"type": "number",
"example": 123
},
"mobile_phone": {
"type": "string",
"example": "555-0507"
},
"street_first": {
"type": "string",
"example": "84 Glenwood Street"
},
"team_history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"team_id": {
"type": "number",
"example": 1
},
"end_date": {
"type": "string",
"example": "201-01-01"
},
"team_name": {
"type": "string",
"example": "Some Team"
},
"start_date": {
"type": "string",
"example": "2018-01-01"
}
}
}
},
"date_of_birth": {
"type": "string",
"example": "1991-02-13"
},
"street_second": {
"type": "string",
"example": "Peoria"
},
"employee_number": {
"type": "string",
"example": "A01"
},
"position_history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"example": "201-01-01"
},
"start_date": {
"type": "string",
"example": "2018-01-01"
},
"position_id": {
"type": "number",
"example": 1
},
"position_code": {
"type": "string",
"example": "1234"
},
"position_name": {
"type": "string",
"example": "Developer"
}
}
}
},
"employment_status": {
"type": "string",
"example": "Full-time"
},
"employment_start_date": {
"type": "string",
"example": "2014-08-25"
},
"reports_to_employee_id": {
"type": "number",
"example": 5
},
"employment_status_history": {
"type": "array",
"items": {
"type": "object",
"properties": {
"end_date": {
"type": "string",
"example": "201-01-01"
},
"start_date": {
"type": "string",
"example": "2018-01-01"
},
"employment_status_id": {
"type": "number",
"example": 1
},
"employment_statu_name": {
"type": "string",
"example": "Full time"
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
EmployeeListTerminatedEmployeesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 19,
"email": "john@example.com",
"position": "Api developer",
"last_name": "Doe",
"first_name": "John",
"picture_url": "https://example.com/john.png",
"date_of_birth": "1991-02-13",
"employee_number": "123",
"termination_date": "2015-05-28",
"employment_start_date": "2014-08-25"
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"email": {
"type": "string",
"example": "john@example.com"
},
"position": {
"type": "string",
"example": "Api developer"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"first_name": {
"type": "string",
"example": "John"
},
"picture_url": {
"type": "string",
"example": "https://example.com/john.png"
},
"date_of_birth": {
"type": "string",
"example": "1991-02-13"
},
"employee_number": {
"type": "string",
"example": "123"
},
"termination_date": {
"type": "string",
"example": "2015-05-28"
},
"employment_start_date": {
"type": "string",
"example": "2014-08-25"
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
EmployeeTerminateEmployeeRequest
{
"type": "object",
"required": [
"date",
"termination_reason_id"
],
"properties": {
"date": {
"type": "string",
"description": "Last working day; format: YYYY-MM-DD"
},
"comments": {
"type": "string",
"description": "Comments"
},
"termination_reason_id": {
"type": "number",
"description": "Termination reason ID"
}
}
}
EmployeeTerminateEmployeeResponse
{
"type": "object",
"example": {
"data": {}
},
"properties": {
"data": {
"type": "object",
"properties": {}
}
}
}
EmployeeUpdateById404Response
{
"type": "object",
"example": {
"errors": [],
"error_code": "not_found"
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string"
}
},
"error_code": {
"type": "string",
"example": "not_found"
}
}
}
EmployeeUpdateByIdRequest
{
"type": "object",
"properties": {
"team_id": {
"type": "integer",
"example": 2
},
"last_name": {
"type": "string",
"example": "Doe"
},
"leader_id": {
"type": "integer",
"example": 3
},
"first_name": {
"type": "string",
"example": "Jane"
},
"location_id": {
"type": "integer",
"example": 1
},
"position_id": {
"type": "integer",
"example": 101
},
"approver_ids": {
"type": "array",
"items": {
"type": "integer",
"example": 1
}
},
"employee_number": {
"type": "string",
"example": "0123456"
},
"work_start_date": {
"type": "string",
"example": "2020-01-28"
},
"selected_leave_types": {
"type": "array",
"items": {
"type": "integer",
"example": 2
}
}
}
}
EmployeeUpdateByIdResponse
{
"type": "object",
"example": {
"data": {
"id": 1711
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1711
}
}
}
}
}
EmployeeUpdateCustomField422Response
{
"type": "object",
"example": {
"errors": [
"Custom field text too long (max 250 characters)"
],
"error_code": "validation_failed"
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "Custom field text too long (max 250 characters)"
}
},
"error_code": {
"type": "string",
"example": "validation_failed"
}
}
}
EmployeeUpdateCustomFieldRequest
{
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"type": "string",
"description": "String or array (for tags)"
}
}
}
EmployeeUpdateCustomFieldResponse
{
"type": "object",
"example": {
"data": null
},
"properties": {
"data": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
}
}
}
IntegrationsImportNewStartersListResponse
{
"type": "object",
"example": {
"data": {
"npd": "NPD",
"email": "test@test.com",
"gender": "male",
"status": 1,
"address": "Street 1, City",
"home_city": "employee home city (custom_field)",
"last_name": "Doe",
"country_id": "country id (GB)",
"first_name": "John",
"employee_id": 1,
"personal_code": "personal code (custom_field)",
"employee_number": 123,
"work_start_date": "2020-10-10T00:00:00.000Z",
"social_security_code": "social security code (custom_field)"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"npd": {
"type": "string",
"example": "NPD"
},
"email": {
"type": "string",
"example": "test@test.com"
},
"gender": {
"type": "string",
"example": "male"
},
"status": {
"type": "number",
"example": 1
},
"address": {
"type": "string",
"example": "Street 1, City"
},
"home_city": {
"type": "string",
"example": "employee home city (custom_field)"
},
"last_name": {
"type": "string",
"example": "Doe"
},
"country_id": {
"type": "string",
"example": "country id (GB)"
},
"first_name": {
"type": "string",
"example": "John"
},
"employee_id": {
"type": "number",
"example": 1
},
"personal_code": {
"type": "string",
"example": "personal code (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
},
"work_start_date": {
"type": "string",
"example": "2020-10-10T00:00:00.000Z"
},
"social_security_code": {
"type": "string",
"example": "social security code (custom_field)"
}
}
}
}
}
IntegrationsSendBonusesToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"type": "Bonus",
"amount": 1000,
"status": 1,
"end_date": "2020-10-10",
"start_date": "2020-09-10",
"compensation_id": 1,
"contract_number": "contract number (custom_field)",
"employee_number": 123
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "Bonus"
},
"amount": {
"type": "number",
"example": 1000
},
"status": {
"type": "number",
"example": 1
},
"end_date": {
"type": "string",
"example": "2020-10-10"
},
"start_date": {
"type": "string",
"example": "2020-09-10"
},
"compensation_id": {
"type": "number",
"example": 1
},
"contract_number": {
"type": "string",
"example": "contract number (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
}
}
}
}
}
IntegrationsTransferAppointmentInfoResponse
{
"type": "object",
"example": {
"data": {
"status": 1,
"job_type": "job type (custom_field)",
"employee_id": 1,
"position_id": 1,
"schedule_id": "scheduled id (custom_field)",
"employee_number": 123,
"work_start_date": "2020-01-10",
"cost_center_code": "cost center code (custom_field)",
"employment_status": "Full-time",
"position_start_date": "2020-10-10",
"last_position_end_date": "2020-09-10"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "number",
"example": 1
},
"job_type": {
"type": "string",
"example": "job type (custom_field)"
},
"employee_id": {
"type": "number",
"example": 1
},
"position_id": {
"type": "number",
"example": 1
},
"schedule_id": {
"type": "string",
"example": "scheduled id (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
},
"work_start_date": {
"type": "string",
"example": "2020-01-10"
},
"cost_center_code": {
"type": "string",
"example": "cost center code (custom_field)"
},
"employment_status": {
"type": "string",
"example": "Full-time"
},
"position_start_date": {
"type": "string",
"example": "2020-10-10"
},
"last_position_end_date": {
"type": "string",
"example": "2020-09-10"
}
}
}
}
}
IntegrationsTransferBankAccountInfoResponse
{
"type": "object",
"example": {
"data": {
"status": 1,
"bank_code": "bank code (custom_field)",
"employee_id": 1,
"last_change": "2020-09-10",
"bank_account": "bank account (custom_field)",
"employee_number": 123
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "number",
"example": 1
},
"bank_code": {
"type": "string",
"example": "bank code (custom_field)"
},
"employee_id": {
"type": "number",
"example": 1
},
"last_change": {
"type": "string",
"example": "2020-09-10"
},
"bank_account": {
"type": "string",
"example": "bank account (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
}
}
}
}
}
IntegrationsTransferContractInformationToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"status": 1,
"employee_id": 1,
"contract_type": "contract type (custom_field)",
"contract_number": "contract number (custom_field)",
"employee_number": 123,
"work_start_date": "2020-10-10T00:00:00.000Z",
"termination_date": "2020-10-11T00:00:00.000Z",
"employment_status": "Full-time"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "number",
"example": 1
},
"employee_id": {
"type": "number",
"example": 1
},
"contract_type": {
"type": "string",
"example": "contract type (custom_field)"
},
"contract_number": {
"type": "string",
"example": "contract number (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
},
"work_start_date": {
"type": "string",
"example": "2020-10-10T00:00:00.000Z"
},
"termination_date": {
"type": "string",
"example": "2020-10-11T00:00:00.000Z"
},
"employment_status": {
"type": "string",
"example": "Full-time"
}
}
}
}
}
IntegrationsTransferJobPositionFromSageToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"id": 1,
"title": "Job title",
"status": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"title": {
"type": "string",
"example": "Job title"
},
"status": {
"type": "number",
"example": 1
}
}
}
}
}
IntegrationsTransferLeaveInformationToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"days": 2,
"status": 1,
"end_date": "2020-10-10",
"leave_type": "Vacation",
"start_date": "2020-10-10",
"employee_number": 123,
"calendar_event_id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"days": {
"type": "number",
"example": 2
},
"status": {
"type": "number",
"example": 1
},
"end_date": {
"type": "string",
"example": "2020-10-10"
},
"leave_type": {
"type": "string",
"example": "Vacation"
},
"start_date": {
"type": "string",
"example": "2020-10-10"
},
"employee_number": {
"type": "number",
"example": 123
},
"calendar_event_id": {
"type": "number",
"example": 1
}
}
}
}
}
IntegrationsTransferOrganizationalStructureFromSageToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"status": 1,
"work_city": "employee city (custom_field)",
"employee_id": 1,
"section_code": "section code (custom_field)",
"work_address": "employee address (custom_field)",
"section_title": "section title (custom_field)",
"department_code": "department code (custom_field)",
"department_name": "department name (custom_field)",
"subsection_code": "subsection code (custom_field)",
"cost_center_code": "cost center code (custom_field)",
"subsection_title": "Test Team",
"cost_center_title": "cost center tile (custom_field)"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "number",
"example": 1
},
"work_city": {
"type": "string",
"example": "employee city (custom_field)"
},
"employee_id": {
"type": "number",
"example": 1
},
"section_code": {
"type": "string",
"example": "section code (custom_field)"
},
"work_address": {
"type": "string",
"example": "employee address (custom_field)"
},
"section_title": {
"type": "string",
"example": "section title (custom_field)"
},
"department_code": {
"type": "string",
"example": "department code (custom_field)"
},
"department_name": {
"type": "string",
"example": "department name (custom_field)"
},
"subsection_code": {
"type": "string",
"example": "subsection code (custom_field)"
},
"cost_center_code": {
"type": "string",
"example": "cost center code (custom_field)"
},
"subsection_title": {
"type": "string",
"example": "Test Team"
},
"cost_center_title": {
"type": "string",
"example": "cost center tile (custom_field)"
}
}
}
}
}
IntegrationsTransferSalaryInformationResponse
{
"type": "object",
"example": {
"data": {
"type": "Salary",
"amount": 1000,
"status": 1,
"end_date": "2020-10-10",
"start_date": "2020-09-10",
"compensation_id": 1,
"contract_number": "contract number (custom_field)",
"employee_number": 123
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"type": {
"type": "string",
"example": "Salary"
},
"amount": {
"type": "number",
"example": 1000
},
"status": {
"type": "number",
"example": 1
},
"end_date": {
"type": "string",
"example": "2020-10-10"
},
"start_date": {
"type": "string",
"example": "2020-09-10"
},
"compensation_id": {
"type": "number",
"example": 1
},
"contract_number": {
"type": "string",
"example": "contract number (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
}
}
}
}
}
IntegrationsTransferTerminationInfoToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"status": 1,
"employee_id": 1,
"unused_days": 5,
"compensation": 1000,
"contract_number": "contract number (custom_field)",
"employee_number": 123,
"termination_date": "2020-09-10",
"termination_reason": "New job",
"termination_comment": "Was good employee"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"status": {
"type": "number",
"example": 1
},
"employee_id": {
"type": "number",
"example": 1
},
"unused_days": {
"type": "number",
"example": 5
},
"compensation": {
"type": "number",
"example": 1000
},
"contract_number": {
"type": "string",
"example": "contract number (custom_field)"
},
"employee_number": {
"type": "number",
"example": 123
},
"termination_date": {
"type": "string",
"example": "2020-09-10"
},
"termination_reason": {
"type": "string",
"example": "New job"
},
"termination_comment": {
"type": "string",
"example": "Was good employee"
}
}
}
}
}
IntegrationsTransferTimeScheduleInformationResponse
{
"type": "object",
"example": {
"data": {
"date": "2020-10-10",
"hours": 8.5,
"status": 1,
"stand_by": 8,
"nightours": 0.5,
"employee_id": 1,
"overtime_title": 0.5,
"employee_number": 123,
"cost_center_code": "cost center code (custom field)"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"date": {
"type": "string",
"example": "2020-10-10"
},
"hours": {
"type": "number",
"example": 8.5
},
"status": {
"type": "number",
"example": 1
},
"stand_by": {
"type": "number",
"example": 8
},
"nightours": {
"type": "number",
"example": 0.5
},
"employee_id": {
"type": "number",
"example": 1
},
"overtime_title": {
"type": "number",
"example": 0.5
},
"employee_number": {
"type": "number",
"example": 123
},
"cost_center_code": {
"type": "string",
"example": "cost center code (custom field)"
}
}
}
}
}
IntegrationsTransferUnusedVacationDaysToVikarinaResponse
{
"type": "object",
"example": {
"data": {
"date": "2020-10-10",
"status": 1,
"employee_id": 1,
"unused_days": 5,
"employee_number": 123
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"date": {
"type": "string",
"example": "2020-10-10"
},
"status": {
"type": "number",
"example": 1
},
"employee_id": {
"type": "number",
"example": 1
},
"unused_days": {
"type": "number",
"example": 5
},
"employee_number": {
"type": "number",
"example": 123
}
}
}
}
}
LeaveManagementCreateKitDay422Response
{
"type": "object",
"example": {
"errors": [
"First error",
"Second error"
],
"error_code": "validation_failed"
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "First error"
}
},
"error_code": {
"type": "string",
"example": "validation_failed"
}
}
}
LeaveManagementCreateKitDayRequest
{
"type": "object",
"required": [
"policy_id",
"employee_id"
],
"properties": {
"date": {
"type": "string",
"example": "2020-01-01",
"description": "Date of single-day KIT day"
},
"date_to": {
"type": "string",
"example": "2020-01-01",
"description": "End date of a multi-day KIT day"
},
"date_from": {
"type": "string",
"example": "2020-01-01",
"description": "Start date of a multi-day KIT day"
},
"policy_id": {
"type": "integer",
"description": "Time-off policy identifier"
},
"employee_id": {
"type": "integer",
"description": "Employee identifier"
}
}
}
LeaveManagementCreateKitDayResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
}
LeaveManagementGetIndividualAllowancesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 11,
"full_name": "Joe Doe",
"eligibilities": [
{
"unit": "days",
"policy": {
"id": 2,
"name": "Sickday"
},
"quantity": "0.0",
"carryover": "0.0"
},
{
"unit": "days",
"policy": {
"id": 1,
"name": "Vacation"
},
"quantity": "25.0",
"carryover": "100.0"
}
]
},
{
"id": 13,
"full_name": "Jane Doe",
"eligibilities": [
{
"unit": "days",
"policy": {
"id": 4,
"name": "Custom Policy"
},
"quantity": "0.0",
"carryover": "0.0"
},
{
"unit": "days",
"policy": {
"id": 1,
"name": "Vacation"
},
"quantity": "25.0",
"carryover": "100.0"
}
]
}
],
"meta": {
"per_page": 25,
"next_page": null,
"total_pages": 1,
"current_page": 1,
"previous_page": null,
"total_entries": 1
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 11
},
"full_name": {
"type": "string",
"example": "Joe Doe"
},
"eligibilities": {
"type": "array",
"items": {
"type": "object",
"properties": {
"unit": {
"type": "string",
"example": "days"
},
"policy": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 2
},
"name": {
"type": "string",
"example": "Sickday"
}
}
},
"quantity": {
"type": "string",
"example": "0.0"
},
"carryover": {
"type": "string",
"example": "0.0"
}
}
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 25
},
"next_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_pages": {
"type": "number",
"example": 1
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 1
}
}
}
}
}
LeaveManagementGetKitDaysResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"status": "declined",
"end_date": "2021-03-10",
"start_date": "2021-03-09"
},
{
"id": 2,
"status": "approved",
"end_date": "2021-03-10",
"start_date": "2021-03-09"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"status": {
"type": "string",
"example": "declined"
},
"end_date": {
"type": "string",
"example": "2021-03-10"
},
"start_date": {
"type": "string",
"example": "2021-03-09"
}
}
}
}
}
}
LeaveManagementGetTimeOffBalancesResponse
{
"type": "object",
"example": {
"data": [
{
"used": 5.6,
"available": 2,
"policy_id": 1
},
{
"used": 75,
"available": null,
"policy_id": 2
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"used": {
"type": "number",
"example": 5.6
},
"available": {
"type": "number",
"example": 2,
"nullable": true
},
"policy_id": {
"type": "number",
"example": 1
}
}
}
}
}
}
LeaveManagementGetTimeOffPolicyByIdResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"name": "Vacation",
"unit": "days",
"color": "#3a7dd8",
"no_reset": false,
"accrue_type": "yearly",
"max_accrual": false,
"auto_approves": false,
"do_not_accrue": false,
"max_carryover": "100.0",
"blocks_enabled": false,
"enable_details": true,
"only_full_days": false,
"accrue_at_start": true,
"require_details": false,
"additional_field": true,
"default_allowance": "25.0",
"enable_attachment": false,
"enable_replacement": false,
"enable_limited_days": false,
"enable_minimum_days": false,
"replacement_required": false,
"enable_employee_access": true,
"child_allowance_enabled": false,
"enable_probation_period": false,
"enable_replacement_away": false,
"enable_service_accruals": false,
"enable_dependent_policy\"": false,
"enable_monthly_expiration": false,
"enable_negative_carryover": false,
"enable_specific_approvers": false,
"termination_recalculation": true,
"dont_allow_negative_amount": false,
"enable_duplicate_time_offs": false,
"enable_scopped_replacement": false,
"override_approvers_enabled": false,
"requests_in_advance_required": false,
"starter_yearly_accrual_limitation": false,
"starter_monthly_accrual_limitation": false
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Vacation"
},
"unit": {
"type": "string",
"example": "days"
},
"color": {
"type": "string",
"example": "#3a7dd8"
},
"no_reset": {
"type": "boolean",
"example": false
},
"accrue_type": {
"type": "string",
"example": "yearly"
},
"max_accrual": {
"type": "boolean",
"example": false
},
"auto_approves": {
"type": "boolean",
"example": false
},
"do_not_accrue": {
"type": "boolean",
"example": false
},
"max_carryover": {
"type": "string",
"example": "100.0"
},
"blocks_enabled": {
"type": "boolean",
"example": false
},
"enable_details": {
"type": "boolean",
"example": true
},
"only_full_days": {
"type": "boolean",
"example": false
},
"accrue_at_start": {
"type": "boolean",
"example": true
},
"require_details": {
"type": "boolean",
"example": false
},
"additional_field": {
"type": "boolean",
"example": true
},
"default_allowance": {
"type": "string",
"example": "25.0"
},
"enable_attachment": {
"type": "boolean",
"example": false
},
"enable_replacement": {
"type": "boolean",
"example": false
},
"enable_limited_days": {
"type": "boolean",
"example": false
},
"enable_minimum_days": {
"type": "boolean",
"example": false
},
"replacement_required": {
"type": "boolean",
"example": false
},
"enable_employee_access": {
"type": "boolean",
"example": true
},
"child_allowance_enabled": {
"type": "boolean",
"example": false
},
"enable_probation_period": {
"type": "boolean",
"example": false
},
"enable_replacement_away": {
"type": "boolean",
"example": false
},
"enable_service_accruals": {
"type": "boolean",
"example": false
},
"enable_dependent_policy\"": {
"type": "boolean",
"example": false
},
"enable_monthly_expiration": {
"type": "boolean",
"example": false
},
"enable_negative_carryover": {
"type": "boolean",
"example": false
},
"enable_specific_approvers": {
"type": "boolean",
"example": false
},
"termination_recalculation": {
"type": "boolean",
"example": true
},
"dont_allow_negative_amount": {
"type": "boolean",
"example": false
},
"enable_duplicate_time_offs": {
"type": "boolean",
"example": false
},
"enable_scopped_replacement": {
"type": "boolean",
"example": false
},
"override_approvers_enabled": {
"type": "boolean",
"example": false
},
"requests_in_advance_required": {
"type": "boolean",
"example": false
},
"starter_yearly_accrual_limitation": {
"type": "boolean",
"example": false
},
"starter_monthly_accrual_limitation": {
"type": "boolean",
"example": false
}
}
}
}
}
}
LeaveManagementListEmployeesOutTodayResponse
{
"type": "object",
"example": {
"data": [
{
"id": 2902504,
"hours": 3.5,
"policy": {
"name": "Vacation"
},
"details": "Birthday lunch",
"employee": {
"last_name": "Doe",
"first_name": "John"
},
"end_date": "2018-05-24",
"policy_id": 2,
"start_date": "2018-05-24",
"employee_id": 5,
"is_multi_date": false,
"is_single_day": true,
"is_part_of_day": true,
"first_part_of_day": false,
"second_part_of_day": true
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 2902504
},
"hours": {
"type": "number",
"example": 3.5
},
"policy": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "Vacation"
}
}
},
"details": {
"type": "string",
"example": "Birthday lunch"
},
"employee": {
"type": "object",
"properties": {
"last_name": {
"type": "string",
"example": "Doe"
},
"first_name": {
"type": "string",
"example": "John"
}
}
},
"end_date": {
"type": "string",
"example": "2018-05-24"
},
"policy_id": {
"type": "number",
"example": 2
},
"start_date": {
"type": "string",
"example": "2018-05-24"
},
"employee_id": {
"type": "number",
"example": 5
},
"is_multi_date": {
"type": "boolean",
"example": false
},
"is_single_day": {
"type": "boolean",
"example": true
},
"is_part_of_day": {
"type": "boolean",
"example": true
},
"first_part_of_day": {
"type": "boolean",
"example": false
},
"second_part_of_day": {
"type": "boolean",
"example": true
}
}
}
}
}
}
LeaveManagementListTimeOffPoliciesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"name": "Vacation",
"unit": "days",
"color": "#49B284",
"accrue_type": "yearly",
"do_not_accrue": false,
"max_carryover": "100.0",
"default_allowance": "26"
},
{
"id": 2,
"name": "Sickday",
"unit": "days",
"color": "#DB263F",
"accrue_type": "no_tracking",
"do_not_accrue": true,
"max_carryover": "0.0",
"default_allowance": "0.0"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"name": {
"type": "string",
"example": "Vacation"
},
"unit": {
"type": "string",
"example": "days"
},
"color": {
"type": "string",
"example": "#49B284"
},
"accrue_type": {
"type": "string",
"example": "yearly"
},
"do_not_accrue": {
"type": "boolean",
"example": false
},
"max_carryover": {
"type": "string",
"example": "100.0"
},
"default_allowance": {
"type": "string",
"example": "26"
}
}
}
}
}
}
LeaveManagementListTimeOffRequestsResponse
{
"type": "object",
"example": {
"data": [
{
"id": 2902504,
"hours": 3.5,
"fields": [
{
"title": "Approved by manager?",
"answer": "yes"
}
],
"status": "Approved",
"details": "Birthday lunch",
"end_date": "2018-05-24",
"policy_id": 1,
"start_date": "2018-05-24",
"employee_id": 1,
"status_code": "approved",
"request_date": "2018-05-22",
"approval_date": null,
"is_multi_date": false,
"is_single_day": true,
"is_part_of_day": true,
"first_part_of_day": false,
"second_part_of_day": true
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 2902504
},
"hours": {
"type": "number",
"example": 3.5
},
"fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Approved by manager?"
},
"answer": {
"type": "string",
"example": "yes"
}
}
}
},
"status": {
"type": "string",
"example": "Approved"
},
"details": {
"type": "string",
"example": "Birthday lunch"
},
"end_date": {
"type": "string",
"example": "2018-05-24"
},
"policy_id": {
"type": "number",
"example": 1
},
"start_date": {
"type": "string",
"example": "2018-05-24"
},
"employee_id": {
"type": "number",
"example": 1
},
"status_code": {
"type": "string",
"example": "approved"
},
"request_date": {
"type": "string",
"example": "2018-05-22"
},
"approval_date": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"is_multi_date": {
"type": "boolean",
"example": false
},
"is_single_day": {
"type": "boolean",
"example": true
},
"is_part_of_day": {
"type": "boolean",
"example": true
},
"first_part_of_day": {
"type": "boolean",
"example": false
},
"second_part_of_day": {
"type": "boolean",
"example": true
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
LeaveManagementNewTimeOffRequest422Response
{
"type": "object",
"example": {
"errors": [
"Error message"
],
"error_code": "validation_failed"
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "Error message"
}
},
"error_code": {
"type": "string",
"example": "validation_failed"
}
}
}
LeaveManagementNewTimeOffRequestRequest
{
"type": "object",
"required": [
"type",
"time_off_policy_id",
"employee_id",
"part_of_day"
],
"properties": {
"date": {
"type": "string",
"description": "format: YYYY-MM-DD; required if type is single"
},
"type": {
"enum": [
"single",
"multi"
],
"type": "string"
},
"hours": {
"type": "number",
"description": "required if type is single & part_of_day is first_part_of_day or second_part_of_day"
},
"date_to": {
"type": "string",
"description": "format: YYYY-MM-DD; required if type is multi"
},
"details": {
"type": "string",
"description": "required based on policy settings"
},
"time_to": {
"type": "string",
"example": "15:00",
"description": "format: H:M; required if part_of_day is specific_timespan"
},
"date_from": {
"type": "string",
"description": "format: YYYY-MM-DD; required if type is multi"
},
"time_from": {
"type": "string",
"example": "07:30",
"description": "format: H:M; required if part_of_day is specific_timespan"
},
"employee_id": {
"type": "integer"
},
"part_of_day": {
"enum": [
"all_day",
"first_part_of_day",
"second_part_of_day",
"specific_timespan"
],
"type": "string",
"description": "required if type is single"
},
"time_off_policy_id": {
"type": "integer"
}
}
}
LeaveManagementNewTimeOffRequestResponse
{
"type": "object",
"example": {
"data": {
"id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
LeaveManagementProcessKitDayRequest
{
"type": "object",
"required": [
"status"
],
"properties": {
"status": {
"enum": [
"cancel",
"approve",
"decline"
],
"type": "string",
"description": "Action to apply to the specified KIT day"
}
}
}
LeaveManagementUpdateKitDaysConfigurationRequest
{
"type": "object",
"required": [
"kit_days_enabled",
"kit_days_quantity"
],
"properties": {
"kit_days_enabled": {
"enum": [
true,
false
],
"type": "boolean",
"example": true,
"description": "Whether the policy allows Kit days or not"
},
"kit_days_quantity": {
"type": "integer",
"example": 5,
"description": "Maximum number of Kit days allowed in the policy"
}
}
}
LeaveManagementUpdateKitDaysConfigurationResponse
{
"type": "object",
"example": {
"errors": [
"The policy specified is not an event-based policy"
],
"error_code": "invalid_policy_type"
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "The policy specified is not an event-based policy"
}
},
"error_code": {
"type": "string",
"example": "invalid_policy_type"
}
}
}
OffboardingCreateTaskRequest
{
"type": "object",
"required": [
"title",
"boarding_task_template_category_id",
"due_in"
],
"properties": {
"title": {
"type": "string"
},
"due_in": {
"type": "number",
"example": 30,
"description": "Due date in days before employee last working day"
},
"assignee_id": {
"type": "number",
"description": "Specific assignee if default_assignee_type is 'employee'"
},
"description": {
"type": "string"
},
"require_attachment": {
"type": "string",
"description": "'true' to enabled required attachment"
},
"default_assignee_type": {
"enum": [
"self",
"leader",
"employee"
],
"type": "string",
"description": "Default: self; leader - direct manager; employee - specific employee via assignee_id"
},
"boarding_task_template_category_id": {
"type": "number"
}
}
}
OffboardingCreateTaskResponse
{
"type": "object",
"example": {
"data": {
"id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
OffboardingListCategoriesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"title": "General"
},
{
"id": 2,
"title": "Platform"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"title": {
"type": "string",
"example": "General"
}
}
}
}
}
}
OnboardingCreateNewTaskRequest
{
"type": "object",
"required": [
"title",
"boarding_task_template_category_id",
"due_in"
],
"properties": {
"title": {
"type": "string"
},
"due_in": {
"type": "number",
"example": 30,
"description": "Due date in days after employee start date"
},
"add_after": {
"type": "number",
"description": "Task start date in days after employee start date"
},
"assignee_id": {
"type": "number",
"description": "Specific assignee if default_assignee_type is 'employee'"
},
"description": {
"type": "string"
},
"require_attachment": {
"type": "string",
"description": "'true' to enabled required attachment"
},
"default_assignee_type": {
"enum": [
"self",
"leader",
"employee"
],
"type": "string",
"description": "Default: self; leader - direct manager; employee - specific employee via assignee_id"
},
"boarding_task_template_category_id": {
"type": "number"
}
}
}
OnboardingCreateNewTaskResponse
{
"type": "object",
"example": {
"data": {
"id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
OnboardingListTaskCategoriesResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"title": "General"
},
{
"id": 2,
"title": "Platform"
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"title": {
"type": "string",
"example": "General"
}
}
}
}
}
}
PerformanceGetQuarterlyCompanyGoalsResponse
{
"type": "object",
"example": {
"data": [
{
"title": "Optimize data storage",
"progress": {
"actual": 10,
"to_date": 34
}
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Optimize data storage"
},
"progress": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 10
},
"to_date": {
"type": "number",
"example": 34
}
}
}
}
}
}
}
}
PerformanceGetQuarterlyIndividualGoalsResponse
{
"type": "object",
"example": {
"data": [
{
"name": "John Doe",
"goals": [
{
"title": "Optimize data storage",
"progress": {
"actual": 10,
"to_date": 34
}
}
],
"progress": {
"actual": 10,
"to_date": 34
}
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"goals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Optimize data storage"
},
"progress": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 10
},
"to_date": {
"type": "number",
"example": 34
}
}
}
}
}
},
"progress": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 10
},
"to_date": {
"type": "number",
"example": 34
}
}
}
}
}
}
}
}
PerformanceGetQuarterlyTeamGoalsResponse
{
"type": "object",
"example": {
"data": [
{
"name": "HR team",
"goals": [
{
"title": "Optimize data storage",
"progress": {
"actual": 10,
"to_date": 34
}
}
],
"progress": {
"actual": 10,
"to_date": 34
}
}
]
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "HR team"
},
"goals": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Optimize data storage"
},
"progress": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 10
},
"to_date": {
"type": "number",
"example": 34
}
}
}
}
}
},
"progress": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 10
},
"to_date": {
"type": "number",
"example": 34
}
}
}
}
}
}
}
}
PerformanceOverviewQuarterlyProgressResponse
{
"type": "object",
"example": {
"data": {
"team": {
"actual": 37,
"adjusted": 42
},
"company": {
"actual": 15,
"adjusted": 18
},
"individual": {
"actual": 26,
"adjusted": 31
}
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"team": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 37
},
"adjusted": {
"type": "number",
"example": 42
}
}
},
"company": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 15
},
"adjusted": {
"type": "number",
"example": 18
}
}
},
"individual": {
"type": "object",
"properties": {
"actual": {
"type": "number",
"example": 26
},
"adjusted": {
"type": "number",
"example": 31
}
}
}
}
}
}
}
PositionsListCompanyPositionsResponse
{
"type": "object",
"example": {
"data": [
{
"id": 19,
"code": "X2",
"title": "CFO",
"description": "..."
},
{
"id": 20,
"code": null,
"title": "CEO",
"description": null
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"code": {
"type": "string",
"example": "X2",
"nullable": true
},
"title": {
"type": "string",
"example": "CFO"
},
"description": {
"type": "string",
"example": "...",
"nullable": true
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
RecruitmentCreateApplicantWithReferral422Response
{
"type": "object",
"example": {
"errors": [
"Email has already been taken"
],
"error_code": "validation_failed"
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "Email has already been taken"
}
},
"error_code": {
"type": "string",
"example": "validation_failed"
}
}
}
RecruitmentCreateApplicantWithReferralRequest
{
"type": "object",
"required": [
"applicant[first_name]"
],
"properties": {
"applicant[email]": {
"type": "string"
},
"applicant[source]": {
"type": "string"
},
"applicant[address]": {
"type": "string"
},
"applicant[summary]": {
"type": "string"
},
"applicant[referral]": {
"type": "string"
},
"applicant[last_name]": {
"type": "string"
},
"send_thank_you_email": {
"type": "string",
"description": "'true' to send thank you email to applicant"
},
"applicant[attachment]": {
"type": "string",
"format": "binary",
"description": "The file to upload."
},
"applicant[first_name]": {
"type": "string"
},
"applicant[phone_number]": {
"type": "string"
}
}
}
RecruitmentCreateApplicantWithReferralResponse
{
"type": "object",
"example": {
"data": {
"id": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
}
}
}
}
}
RecruitmentGetApplicantDetailsResponse
{
"type": "object",
"example": {
"data": {
"id": 3,
"email": "fritzgerard@example.com",
"stage": {
"id": 4,
"title": "Interview",
"created_at": "2020-10-15T10:57:34Z"
},
"source": "referral",
"address": null,
"summary": null,
"added_by": {
"id": 1,
"email": "vlad@example.com",
"full_name": "Vlad Hendrik"
},
"referrer": {
"id": 1,
"email": "josh@example.com",
"full_name": "Josh Pascuale",
"phone_number": 67876162
},
"full_name": "Fritzgerard Stachie",
"last_name": "Stachie",
"created_at": "2020-10-21T12:58:43Z",
"first_name": "Fritzgerard",
"hired_date": null,
"position_id": 1,
"phone_number": null,
"disqualified_date": "2020-10-28"
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 3
},
"email": {
"type": "string",
"example": "fritzgerard@example.com"
},
"stage": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 4
},
"title": {
"type": "string",
"example": "Interview"
},
"created_at": {
"type": "string",
"example": "2020-10-15T10:57:34Z"
}
}
},
"source": {
"type": "string",
"example": "referral"
},
"address": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"summary": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"added_by": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"email": {
"type": "string",
"example": "vlad@example.com"
},
"full_name": {
"type": "string",
"example": "Vlad Hendrik"
}
}
},
"referrer": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"email": {
"type": "string",
"example": "josh@example.com"
},
"full_name": {
"type": "string",
"example": "Josh Pascuale"
},
"phone_number": {
"type": "number",
"example": 67876162
}
}
},
"full_name": {
"type": "string",
"example": "Fritzgerard Stachie"
},
"last_name": {
"type": "string",
"example": "Stachie"
},
"created_at": {
"type": "string",
"example": "2020-10-21T12:58:43Z"
},
"first_name": {
"type": "string",
"example": "Fritzgerard"
},
"hired_date": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"position_id": {
"type": "number",
"example": 1
},
"phone_number": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"disqualified_date": {
"type": "string",
"example": "2020-10-28"
}
}
}
}
}
RecruitmentGetPositionDetailsResponse
{
"type": "object",
"example": {
"data": {
"id": 1,
"link": null,
"team": "",
"group": "Hiring Group",
"title": "CTO",
"status": "completed",
"group_id": 1,
"location": "New York",
"priority": 1,
"applicants": [
{
"id": 1,
"email": "jon.vondrak@example.com",
"full_name": "Jon Vondrak"
},
{
"id": 2,
"email": "sam.cross@example.com",
"full_name": "Samantha Cross"
}
],
"created_at": "2020-10-15",
"visibility": "Completed",
"hiring_team": [
{
"id": 12,
"role": "hiring_manager",
"full_name": "Manel Lopez-Bru"
},
{
"id": 1,
"role": "interviewer",
"full_name": "Pau Capdevilla"
}
],
"location_id": 4,
"completed_at": "2020-10-28",
"internal_date": "2020-10-31",
"employment_type": "Full-time",
"applicants_count": 2,
"description_blocks": [
{
"title": "Description",
"content": "<h1>This Is A CTO Position</h1>"
},
{
"title": "Requirements",
"content": "<p>This is what we required.</p>"
},
{
"title": "Benefits",
"content": "<p>Here are some benefits.</p>"
},
{
"title": "More Details",
"content": "<p>A custom block.</p>"
}
],
"applicants_required": 1
}
},
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"link": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"team": {
"type": "string",
"example": ""
},
"group": {
"type": "string",
"example": "Hiring Group"
},
"title": {
"type": "string",
"example": "CTO"
},
"status": {
"type": "string",
"example": "completed"
},
"group_id": {
"type": "number",
"example": 1
},
"location": {
"type": "string",
"example": "New York"
},
"priority": {
"type": "number",
"example": 1
},
"applicants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"email": {
"type": "string",
"example": "jon.vondrak@example.com"
},
"full_name": {
"type": "string",
"example": "Jon Vondrak"
}
}
}
},
"created_at": {
"type": "string",
"example": "2020-10-15"
},
"visibility": {
"type": "string",
"example": "Completed"
},
"hiring_team": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 12
},
"role": {
"type": "string",
"example": "hiring_manager"
},
"full_name": {
"type": "string",
"example": "Manel Lopez-Bru"
}
}
}
},
"location_id": {
"type": "number",
"example": 4
},
"completed_at": {
"type": "string",
"example": "2020-10-28"
},
"internal_date": {
"type": "string",
"example": "2020-10-31"
},
"employment_type": {
"type": "string",
"example": "Full-time"
},
"applicants_count": {
"type": "number",
"example": 2
},
"description_blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Description"
},
"content": {
"type": "string",
"example": "<h1>This Is A CTO Position</h1>"
}
}
}
},
"applicants_required": {
"type": "number",
"example": 1
}
}
}
}
}
RecruitmentListApplicantActionsResponse
{
"type": "object",
"example": {
"data": [
{
"action": "moved_between_stages",
"message": "Applicant moved from \"Interview\" to \"Reference check\"",
"created_at": "2020-10-28T09:05:45Z"
},
{
"action": "moved_between_stages",
"message": "Applicant moved from \"CV review\" to \"Interview\"",
"created_at": "2020-10-27T10:59:23Z"
},
{
"action": "moved_between_stages",
"message": "Applicant moved from \"New\" to \"CV review\"",
"created_at": "2020-10-15T11:01:39Z"
},
{
"action": "document_created",
"message": "Uploaded \"empty-document.pdf\"",
"created_at": "2020-10-15T10:59:15Z"
},
{
"action": "applicant_created",
"message": "Applicant created",
"created_at": "2020-10-15T10:58:57Z"
}
],
"meta": {
"per_page": 30,
"next_page": null,
"total_pages": 1,
"current_page": 1,
"previous_page": null,
"total_entries": 5
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"action": {
"type": "string",
"example": "moved_between_stages"
},
"message": {
"type": "string",
"example": "Applicant moved from \"Interview\" to \"Reference check\""
},
"created_at": {
"type": "string",
"example": "2020-10-28T09:05:45Z"
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 30
},
"next_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_pages": {
"type": "number",
"example": 1
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 5
}
}
}
}
}
RecruitmentListApplicantsResponse
{
"type": "object",
"example": {
"data": [
{
"id": 1,
"email": "jon.vondrak@example.com",
"stage": {
"id": 6,
"title": "Reference check",
"created_at": "2020-10-15T10:57:34Z"
},
"source": "recruiters",
"address": null,
"summary": null,
"full_name": "Jon Vondrak",
"last_name": "Vondrak",
"created_at": "2020-10-15T10:58:57Z",
"first_name": "Jon",
"hired_date": null,
"phone_number": null,
"disqualified_date": null
},
{
"id": 2,
"email": "sam.cross@example.com",
"stage": {
"id": 10,
"title": "Hired",
"created_at": "2020-10-15T10:57:34Z"
},
"source": "recruiters",
"address": null,
"summary": null,
"full_name": "Samantha Cross",
"last_name": "Cross",
"created_at": "2020-10-15T11:02:34Z",
"first_name": "Samantha",
"hired_date": "2020-10-28",
"phone_number": null,
"disqualified_date": null
}
],
"meta": {
"per_page": 30,
"next_page": null,
"total_pages": 1,
"current_page": 1,
"previous_page": null,
"total_entries": 3
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 1
},
"email": {
"type": "string",
"example": "jon.vondrak@example.com"
},
"stage": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 6
},
"title": {
"type": "string",
"example": "Reference check"
},
"created_at": {
"type": "string",
"example": "2020-10-15T10:57:34Z"
}
}
},
"source": {
"type": "string",
"example": "recruiters"
},
"address": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"summary": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"full_name": {
"type": "string",
"example": "Jon Vondrak"
},
"last_name": {
"type": "string",
"example": "Vondrak"
},
"created_at": {
"type": "string",
"example": "2020-10-15T10:58:57Z"
},
"first_name": {
"type": "string",
"example": "Jon"
},
"hired_date": {
"type": "string",
"example": "2020-10-28",
"nullable": true
},
"phone_number": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"disqualified_date": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 30
},
"next_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_pages": {
"type": "number",
"example": 1
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 3
}
}
}
}
}
RecruitmentListPositionsResponse
{
"type": "object",
"example": {
"data": [
{
"id": 2902504,
"link": "https://talent.sage.hr/jobs/xxx",
"team": "Management",
"group": "Hiring Group",
"title": "CEO",
"status": "published",
"group_id": 871621,
"location": "London",
"priority": 1,
"created_at": "2019-09-01",
"visibility": "Published",
"location_id": 9182712,
"completed_at": null,
"internal_date": "2019-10-01",
"employment_type": "Full-time",
"applicants_count": 3,
"description_blocks": [
{
"title": "Requirements",
"content": "Html content goes here"
}
],
"applicants_required": 1
},
{
"id": 212,
"link": null,
"team": "",
"group": "Hiring Group",
"title": "CFO",
"status": "completed",
"group_id": 871621,
"location": null,
"priority": 9800,
"created_at": "2019-09-01",
"visibility": "Completed",
"location_id": null,
"completed_at": "2019-10-12",
"internal_date": "2019-10-21",
"employment_type": null,
"applicants_count": 4,
"description_blocks": [
{
"title": "Description",
"content": "<p>This is a CFO position.</p>"
},
{
"title": "Requirements",
"content": "<p>Be a CFO</p>"
},
{
"title": "Benefits",
"content": "<p>iPhone 12</p>"
}
],
"applicants_required": 2
}
],
"meta": {
"per_page": 20,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 34
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 2902504
},
"link": {
"type": "string",
"example": "https://talent.sage.hr/jobs/xxx",
"nullable": true
},
"team": {
"type": "string",
"example": "Management"
},
"group": {
"type": "string",
"example": "Hiring Group"
},
"title": {
"type": "string",
"example": "CEO"
},
"status": {
"type": "string",
"example": "published"
},
"group_id": {
"type": "number",
"example": 871621
},
"location": {
"type": "string",
"example": "London",
"nullable": true
},
"priority": {
"type": "number",
"example": 1
},
"created_at": {
"type": "string",
"example": "2019-09-01"
},
"visibility": {
"type": "string",
"example": "Published"
},
"location_id": {
"type": "number",
"example": 9182712,
"nullable": true
},
"completed_at": {
"type": "string",
"example": "2019-10-12",
"nullable": true
},
"internal_date": {
"type": "string",
"example": "2019-10-01"
},
"employment_type": {
"type": "string",
"example": "Full-time",
"nullable": true
},
"applicants_count": {
"type": "number",
"example": 3
},
"description_blocks": {
"type": "array",
"items": {
"type": "object",
"properties": {
"title": {
"type": "string",
"example": "Requirements"
},
"content": {
"type": "string",
"example": "Html content goes here"
}
}
}
},
"applicants_required": {
"type": "number",
"example": 1
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 20
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 34
}
}
}
}
}
TeamsListInCompanyResponse
{
"type": "object",
"example": {
"data": [
{
"id": 19,
"name": "Sales",
"manager_ids": [
1,
2
],
"employee_ids": [
5,
7,
90
]
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"name": {
"type": "string",
"example": "Sales"
},
"manager_ids": {
"type": "array",
"items": {
"type": "number",
"example": 1
}
},
"employee_ids": {
"type": "array",
"items": {
"type": "number",
"example": 5
}
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
TerminationsReasonsListInCompanyResponse
{
"type": "object",
"example": {
"data": [
{
"id": 19,
"code": "NJ",
"name": "New job",
"type": "voluntary"
},
{
"id": 20,
"code": null,
"name": "End of Internship",
"type": "involuntary"
}
],
"meta": {
"per_page": 50,
"next_page": 2,
"total_pages": 2,
"current_page": 1,
"previous_page": null,
"total_entries": 75
}
},
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "number",
"example": 19
},
"code": {
"type": "string",
"example": "NJ",
"nullable": true
},
"name": {
"type": "string",
"example": "New job"
},
"type": {
"type": "string",
"example": "voluntary"
}
}
}
},
"meta": {
"type": "object",
"properties": {
"per_page": {
"type": "number",
"example": 50
},
"next_page": {
"type": "number",
"example": 2
},
"total_pages": {
"type": "number",
"example": 2
},
"current_page": {
"type": "number",
"example": 1
},
"previous_page": {
"type": "string",
"nullable": true,
"x-konfig-null-placeholder": true
},
"total_entries": {
"type": "number",
"example": 75
}
}
}
}
}
TimesheetsClockInOutRequest
{
"type": "object",
"properties": {
"override": {
"type": "string",
"description": "'true' if override provided days clocked entries"
},
"clocked_time": {
"type": "object",
"properties": {
"YYYY/MM/DD": {
"type": "object",
"properties": {
"employee_id": {
"type": "array",
"items": {
"type": "object",
"properties": {
"clock_in": {
"type": "string",
"description": "YYYY/MM/DD HH:MM"
},
"clock_out": {
"type": "string",
"description": "YYYY/MM/DD HH:MM"
}
}
}
}
}
}
}
}
}
}
TimesheetsClockInOutResponse
{
"type": "object",
"example": {
"errors": [
"error 1",
"error 2"
]
},
"properties": {
"errors": {
"type": "array",
"items": {
"type": "string",
"example": "error 1"
}
}
}
}