Sage HR Component
Sage HR is all inclusive Human Resource management solution. Use the Sage HR component to manage Employees, Teams, Projects, and more.
Component key: sage-hrDescription
Sage HR Sage HR is all inclusive Human Resource management solution. Use the Sage HR component to manage Employees, Teams, Projects, and more.
Connections
API Key
Sage HR uses an activated API key for Authentication.
To activate API:
- Sign into Sage HR, click on your name on the top right, then click Settings.
- On the settings menu, click INTEGRATIONS, then click API.
- Click ENABLE API ACCESS to activate access to API and provide you with your unique API key.
- Save the API Key and paste into your Prismatic connection configuration.
Data Sources
Fetch Positions
Fetch an array of positions | key: positions | type: picklist
{
"result": [
{
"label": "CFO",
"key": "19"
}
]
}
Fetch Projects
Fetch an array of Projects | key: projects | type: picklist
{
"result": [
{
"label": "Project Name.",
"key": "123"
}
]
}
Fetch Teams
Fetch an array of teams | key: teams | type: picklist
{
"result": [
{
"label": "Sales",
"key": "19"
}
]
}
Actions
Close Project
Close a project. | key: closeProject
{
"data": {
"data": {
"id": 1
}
}
}
Create Document
Creates a document only visible to the employee themselves. | key: createDocument
{
"data": {
"data": {
"id": 1
}
}
}
Create Employee
Create new employee | key: createEmployee
{
"data": {
"data": {
"id": 1
}
}
}
Create Project
Create a new project. | key: createProject
{
"data": {
"data": {
"id": 1
}
}
}
Create Projects
Create a batch of projects. | key: createProjects
{
"data": {
"data": {
"id": 1
}
}
}
Create Time Off Requests
Create new time off request | key: createTimeOffRequests
{
"data": {
"data": {
"id": 1
}
}
}
Delete Document
Allows admin to delete document. | key: deleteDocument
{
"data": {
"data": {
"id": 1
}
}
}
Get Document
View Document Details. | key: getDocument
{
"data": {
"data": {
"id": 18,
"document_category_id": 15,
"description": "",
"company_id": 5,
"file_name": "test_pdf.pdf",
"file_content_type": "application/pdf",
"file_size": 6193,
"file_updated_at": "2021-06-09T07:32:16.562-07:00",
"shared_with_direct_manager": false,
"shared_with_team_manager": true,
"created_by": 5,
"source": "web",
"created_at": "2021-06-09T14:32:20Z",
"updated_at": "2021-06-09T14:32:20Z",
"shared_with_everyone": false,
"last_edited_by": 5,
"document_template_pattern_id": null,
"acceptance_required": false,
"acceptance_deadline": null,
"file_scan_started_at": null,
"file_scan_result": "Pass",
"document_type": "",
"document_type_other": "",
"right_to_work_number": "",
"expiration_date": null,
"document_expires": false
}
}
}
Get Employee
Retrieve single active employee in company. | key: getEmployee
{
"data": {
"data": {
"id": 19,
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"picture_url": "https://example.com/john.png",
"employment_start_date": "2014-08-25",
"date_of_birth": "1991-02-13",
"team": "Sage HR",
"team_id": 6742,
"position": "Api developer",
"position_id": 123,
"reports_to_employee_id": 5,
"work_phone": "555-0505",
"home_phone": "555-0506",
"mobile_phone": "555-0507",
"gender": "Male",
"street_first": "84 Glenwood Street",
"street_second": "Peoria",
"city": "London",
"post_code": 99999,
"country": "GB",
"employee_number": "A1",
"employment_status": "Full-time",
"nationality": "Spanish",
"marital_status": "Married",
"personal_identification_number": "1",
"tax_number": "1",
"team_history": [
{
"team_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"team_name": "Some Team"
}
],
"employment_status_history": [
{
"employment_status_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"employment_statu_name": "Full time"
}
],
"position_history": [
{
"position_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"position_name": "Developer",
"position_code": "1234"
}
]
}
}
}
Get Employee Compensations
Retrieve single employee's compensation details | key: getEmployeeCompensations
{
"data": {
"data": [
{
"start_date": "2017-01-01",
"end_date": "2019-01-01",
"currency": "EUR",
"amount": 1234,
"period": "monthly",
"comment": "Starting salary",
"category": "Salary"
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"previous_page": null,
"total_pages": 2,
"per_page": 50,
"total_entries": 75
}
}
}
Get Employee Custom Fields
Get employee custom fields | key: getEmployeeCustomFields
{
"data": {
"data": [
{
"id": 1,
"label": "Hobby",
"type": "CustomDropdownField",
"value": "Hockey",
"options": [
"Hockey",
"Football",
"Voleyball"
]
},
{
"id": 2,
"label": "Languages",
"type": "CustomTags",
"options": null,
"value": [
"English",
"Latvian",
"Estonian"
]
}
]
}
}
Get Terminated Employee
Retrieve single terminated employee | key: getTerminatedEmployee
{
"data": {
"data": {
"id": 19,
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"picture_url": "https://example.com/john.png",
"employment_start_date": "2014-08-25",
"date_of_birth": "1991-02-13",
"position": "Api developer",
"position_id": 1234,
"reports_to_employee_id": 1000,
"work_phone": "867-5309",
"home_phone": "555-5555",
"mobile_phone": "555-1234",
"gender": "Male",
"street_first": "123 some Street",
"stree_second": "3A",
"city": "London",
"post_code": "E8 1LA",
"country": "GB",
"employee_number": 123,
"personal_identification_number": "1",
"tax_number": "1",
"termination_date": "2015-05-28",
"termination": {
"reason": "Moving location",
"comments": "Moving to"
}
}
}
}
List Documents
View all documents for company | key: listDocuments
{
"data": {
"data": [
{
"id": 18,
"document_category_id": 15,
"description": "",
"company_id": 5,
"file_name": "test_pdf.pdf",
"file_content_type": "application/pdf",
"file_size": 6193,
"file_updated_at": "2021-06-09T07:32:16.562-07:00",
"shared_with_team_manager": true,
"shared_with_direct_manager": false,
"created_by": 5,
"source": "web",
"created_at": "2021-06-09T14:32:20Z",
"updated_at": "2021-06-09T14:32:20Z",
"shared_with_everyone": false,
"last_edited_by": 5,
"document_template_pattern_id": null,
"acceptance_required": false,
"acceptance_deadline": null,
"file_scan_started_at": null,
"file_scan_result": "Pass",
"document_type": "",
"document_type_other": "",
"right_to_work_number": "",
"expiration_date": null,
"document_expires": false
},
{
"id": 19,
"document_category_id": 15,
"description": "",
"company_id": 5,
"file_name": "test_pdf2.pdf",
"file_content_type": "application/pdf",
"file_size": 6193,
"file_updated_at": "2021-06-09T07:59:56.762-07:00",
"shared_with_managers": true,
"created_by": 5,
"source": "web",
"created_at": "2021-06-09T15:00:20Z",
"updated_at": "2021-06-09T15:00:20Z",
"shared_with_direct_manager": false,
"shared_with_team_manager": true,
"last_edited_by": 5,
"document_template_pattern_id": null,
"acceptance_required": false,
"acceptance_deadline": null,
"file_scan_started_at": null,
"file_scan_result": "Pass",
"document_type": "",
"document_type_other": "",
"right_to_work_number": "",
"expiration_date": null,
"document_expires": false
}
]
}
}
List Employees
List active employees in company. | key: listEmployees
{
"data": {
"data": [
{
"id": 19,
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"picture_url": "https://example.com/john.png",
"employment_start_date": "2014-08-25",
"date_of_birth": "1991-02-13",
"team": "Sage HR",
"team_id": 1,
"position": "Api developer",
"position_id": 123,
"reports_to_employee_id": 5,
"work_phone": "555-0505",
"home_phone": "555-0506",
"mobile_phone": "555-0507",
"gender": "Male",
"street_first": "84 Glenwood Street",
"street_second": "Peoria",
"city": "London",
"post_code": 99999,
"country": "GB",
"employee_number": "A01",
"employment_status": "Full-time",
"nationality": "Spanish",
"marital_status": "Married",
"personal_identification_number": "1",
"tax_number": "1",
"team_history": [
{
"team_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"team_name": "Some Team"
}
],
"employment_status_history": [
{
"employment_status_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"employment_statu_name": "Full time"
}
],
"position_history": [
{
"position_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"position_name": "Developer",
"position_code": "1234"
}
]
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"previous_page": null,
"total_pages": 2,
"per_page": 50,
"total_entries": 75
}
}
}
List Positions
List positions in company | key: listPositions
{
"data": {
"data": [
{
"id": 19,
"title": "CFO",
"description": "...",
"code": "X2"
},
{
"id": 20,
"title": "CEO",
"description": null,
"code": null
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"previous_page": null,
"total_pages": 2,
"per_page": 50,
"total_entries": 75
}
}
}
List Projects
List projects | key: listProjects
List Teams
List teams in company | key: listTeams
{
"data": {
"data": [
{
"id": 19,
"name": "Sales",
"manager_ids": [
1,
2
],
"employee_ids": [
5,
7,
90
]
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"previous_page": null,
"total_pages": 2,
"per_page": 50,
"total_entries": 75
}
}
}
List Terminated Employees
Retrieve a list of terminated employees | key: listTerminatedEmployees
{
"data": {
"data": [
{
"id": 19,
"termination_date": "2015-05-28",
"employee_number": "123",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"picture_url": "https://example.com/john.png",
"employment_start_date": "2014-08-25",
"date_of_birth": "1991-02-13",
"position": "Api developer",
"personal_identification_number": "1",
"tax_number": "1",
"team_history": [
{
"team_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"team_name": "Some Team"
}
],
"employment_status_history": [
{
"employment_status_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"employment_statu_name": "Full time"
}
],
"position_history": [
{
"position_id": 1,
"start_date": "2018-01-01",
"end_date": "201-01-01",
"position_name": "Developer",
"position_code": "1234"
}
]
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"previous_page": null,
"total_pages": 2,
"per_page": 50,
"total_entries": 75
}
}
}
List Time Off Balances
Lists employee time off balances | key: listTimeOffBalances
{
"data": {
"data": [
{
"policy_id": 1,
"used": 5.6,
"available": 2
},
{
"policy_id": 2,
"used": 75,
"available": null
}
]
}
}
List Time Off Requests
Lists employee time off Requests | key: listTimeOffRequests
{
"data": {
"data": [
{
"id": 2902504,
"status": "Approved",
"status_code": "approved",
"policy_id": 1,
"employee_id": 1,
"replacement": {
"id": 2,
"full_name": "John Doe"
},
"details": "Birthday lunch",
"is_multi_date": false,
"is_single_day": true,
"is_part_of_day": true,
"first_part_of_day": false,
"second_part_of_day": true,
"start_date": "2018-05-24",
"end_date": "2018-05-24",
"request_date": "2018-05-22",
"approval_date": null,
"hours": 3.5,
"fields": [
{
"title": "Approved by manager?",
"answer": "yes"
}
]
}
],
"meta": {
"current_page": 1,
"next_page": 2,
"previous_page": null,
"total_pages": 2,
"per_page": 50,
"total_entries": 75
}
}
}
Raw Request
Send raw HTTP request to Sage HR | key: rawRequest
Rehire Employee
Rehire Employee. | key: rehireEmployee
{
"data": {}
}
Terminate Employee
Terminate Employee. | key: terminateEmployee
{
"data": {}
}
Time Clocking In and Out
Clock in and out employees on specific days | key: timeClockingInAndOut
{
"data": {
"errors": [
"error 1",
"error 2"
]
}
}
Update Document
Document will only be visible to employee themselves. | key: updateDocument
{
"data": {
"data": {
"id": 18,
"document_category_id": 15,
"description": "",
"company_id": 5,
"file_name": "test_pdf.pdf",
"file_content_type": "application/pdf",
"file_size": 6193,
"file_updated_at": "2021-06-09T07:32:16.562-07:00",
"shared_with_direct_manager": false,
"shared_with_team_manager": true,
"created_by": 5,
"source": "web",
"created_at": "2021-06-09T14:32:20Z",
"updated_at": "2021-06-09T14:32:20Z",
"shared_with_everyone": false,
"last_edited_by": 5,
"document_template_pattern_id": null,
"acceptance_required": false,
"acceptance_deadline": null,
"file_scan_started_at": null,
"file_scan_result": "Pass",
"document_type": "",
"document_type_other": "",
"right_to_work_number": "",
"expiration_date": null,
"document_expires": false
}
}
}
Update Employee
Update employee | key: updateEmployee
{
"data": {
"data": {
"id": 1711
}
}
}
Update Employee Custom Field
Update employee custom field | key: updateEmployeeCustomField
{
"data": {
"data": null
}
}
Update Project
Update a project. | key: updateProject
{
"data": {
"data": {
"id": 1
}
}
}
Update Projects
Update a batch of projects. | key: updateProjects
{
"data": {
"data": {
"id": 1
}
}
}