Workline is a unique SaaS HRMS that is built from the ground-up based on your specific requirements. As applicable to retail as it is to factories and tech companies, Workline’s comprehensive HR modules, enterprise-grade security and powerful analytics make it a potent tool for business transformation.
Workline API provides a simple RESTful interface with lightweight JSON-formatted responses to use many of its features. Our API uses HTTPS verbs and is built using REST principles, which ensures predictable URLs that makes writing applications easy. REST API provides a powerful, convenient, and simple Web services API for interface. Its advantages include ease of design, integration and development.
With this guide we explain and provide examples for many common integration use cases and show you how to take advantage of Workline's capabilities.
Workline uses conventional HTTP response codes to indicate the success or failure of an API request.
To use our API, you must satisfy the following prerequisites :
Based on request, they will be provided to you through secured communication channels.
If your organization has external vendors who will be involved in interfacing applications, Workline will provide access to them with special credentials.For more information, please contact your Workline administrator and they will guide you through the process.
Authentication to the API is performed via HTTP Basic Auth. Provide your user credentials as the basic auth username and password value. If you need to authenticate via bearer auth , use Bearer authentication tokens. Authentication tokens will be generated and provided to you over secure communication channels.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Never share your secret keys. Keep them guarded and secure.
Workline uses API keys to authenticate requests. If you would like to create a new API key, please contact your Workline administrator.
Your API keys carry many privileges, so be sure to secure them! Do not share your secret API keys with any one.
Based on your organization policy, domain & IP restrictions may have been implemented. To know more about this, please contact your Workline administrator.
API calls are limited to provide better quality of service and availability to all the users.
Workline uses Open API specifications to generate this document. API specifications are written in JSON. The format is easy to learn and readable to both humans and machines.
Download OpenAPI specification: Download
API to Decrypt the information
Application Id. Unique ID to identify the API user. Eg. AV54#23)*cDe
Unique User Name for Authentication
Password for Authentication
Information which is to be decoded.
Decryption Key
Error Flag Eg. True - Success, False - Error
Error Message
Decrypted Value
API to Encrypt the information
Information which is to be encoded
Encryption Key
Encrypted Value
API to check the employee is Valid
Encrypted User ID credential
Encrypted Password credential
Flag to indicate if the Employee ID is valid. Eg. True - Valid False - Invalid
API to get the identity Token
Employee Email ID
Status. Eg. Success, Failure
This API is used to generate access token. This token could be used for Bearer authentication or for allowing access to another API.
Bearer Token for authentication.
Domain Name. This parameter will be used to authenticate the domain from which you are accessing the API.
Token is generated for the authentication
to get the business details
Business Code
Name of the Business
Status of the Business. Eg. Y - Active , N - Inactive
API to get the Custom list
Custom Attribute Code
Custom Attribute Name
Status of the Custom Attribute Eg. Y - Active , N - Inactive
Status of the Custom Attribute. Eg. Y - Active , N - Inactive
To get the Department details
Department Code
Name of the Department
Function Code
Name of the Function
Status of the Department Eg. Y - Active , N - Inactive
To get the Designation details
Designation Code
Name of the Designation
Status of the Designation Eg. Y - Active , N - Inactive
API to get the Cost Center list
Cost Center Code
Cost Center Name
Status of the Cost Center Eg. Y - Active , N - Inactive
To get Function details
Function Name
Status of the Function Eg. Y - Active , N - Inactive
API to get the Location List
Location Code
Name of the Location
Status of the Location Eg. Y - Active , N - Inactive
To get the band data list
Band Code
Name of the Band
Status of the Band Eg. Y - Active , N - Inactive
to get the Team master details
Team Code
Name of the Team
Status of the Team Eg. Y - Active , N - Inactive
To get the custom 5 master details
API to get Custom List
To get the Grade master details
Grade Code
Name of the Grade
Status of the Grade Eg. Y - Active , N - Inactive
API to get the Level Group list
Level Group Code
Name of the Level Group
Status of the Level Group. Eg. Y - Active , N - Inactive
To get the Parent Function details
Parent Function Code
Status of the Function. Eg. Y - Active , N - Inactive
API to get the Region List
Region Code
Name of the Region
Status of the Region. Eg. Y - Active , N - Inactive
API to get the Roles List
Role Code
Name of the Role
Status of the Role. Eg. Y - Active , N - Inactive
API to get the SubFunction List
Sub Function Code
Sub Function Name
Status of the Grade. Eg. Y - Active , N - Inactive
API to get the Unit List
Company Code
Name of the Company
Status of the Company. Eg. Y - Active , N - Inactive
API to get the Workforce Category List
CategoryCode
Name of the Category
Status of the Category. Eg. Y - Active , N - Inactive
To get Zone details
Zone Code
Name of the Zone
Status of the Zone Eg. Y - Active , N - Inactive
API to get the information about the New joiners
From Date Details will be provided from this specific date. Format : dd-MMM-yyyy Eg. 10-Apr-2019
To Date Details will be provided upto this specific date. Format : dd-MMM-yyyy Eg. 25-May-2019
Employee ID
Name of the Employee
Date of Joining
Name of the Sub Band
Designation Name
Location Name
Updated Date. Eg. 13-Oct-2019
Official Mail ID
API to get the information of Active Employees
First name of the Employee
Middle name of the Employee
Last Name of the Employee
Gender of the Employee
Date of Birth of the Employee
Father / Husband name of the Employee
Reason for Hiring Eg. New hire, Rejoining, Conversion
Full Name of Employee
Business Name
Unit Name
FunctionName
Grade
Role Name
Designation Group Code
Designation Group
Zone Name
Region
Location
Name of the City
Name of the State
Name of the Country
Name of Reporting Manager
Name of Skip level Manager
Name of Secondary Appraiser
Status of Employment
In case of Group transfer, Employees date of joining in the Group company
Unit Code
Parent Function Name
Band Name
Location Type Code
Location Type Name
Employee Category Code
Employee Category Name
Functional Manager
Skip Level Manager
Effective From Date
To Get the information about current job
Date-Time Details will be provided based on this particular date. Format : dd-MMM-yyyy Eg. 10-Apr-2019
Latest updated time
To Get the information about employee and his career
Entry Type Details will be provided based on this parameter. C - Details based on Exit entry date A - Details based on Actual date - Exit date
Grade Name
Specify the relation
To Get the information about the Exit employee
Resignation Initiated Date
Last Working Day
Reasons for exiting the organization
Last Updated Timestamp
Admin Manager Name
API to get the list of New joinees
Administrative Manager Name
To Get The Information of the inactive employee
Exit Type
Reason for exiting from the organization
API to get the Employee Details
Application Id
Employee id
API to get the Employee data
From Date
To Date
Employee Name
Date of birth
Salutation
Date Of Joining
Product Name
Department Name
Position Name
Thiruvandram
304109
Reporting Manager ID
Reporting Manager Name
Status of Workforce
Last Modified Date
Record Type
API to get Employee data
Employee Id
Date of birth of Workforce
Gender of Workforce
Date of joining
Region Name
Cost Centre
Employee Status
API to get information about the Exit employees
Application Id. Unique ID to identify the API user. Eg. AV54#23)*cDe.
From Date Details will be provided from this specific date. Format : dd-MMM-yyyy. Eg. 10-Apr-2019
To Date Details will be provided upto this specific date. Format : dd-MMM-yyyy. Eg. 25-May-2019
Entry Type Details will be provided based on this parameter. C - Details based on Career entry date A - Details based on Actual date - Career change date
Gender of Employee
Date of Birth
Specify the relation. Eg. Father / Husband
Position of the Employee
Reporting Manager's Name
API to get the employee data
StartDate Details will be provided from this specific date. Format : dd-MMM-yyyy Eg. 10-Apr-2019
End Date Details will be provided upto this specific date. Format : dd-MMM-yyyy Eg. 25-May-2019
First Name of the Employee
Middle Name of the Employee
Name of business
Name of the Sub Function Name
Employee's Mobile Number
Employee's Last Working Date. Eg. 17-Jan-2020
Status of the EmployeeData. Eg. Y - Active , N - Inactive
API to update the Email ID of the workforce
Employee ID of the employee
Email ID of the employee which is to be updated
Error status
API to get the Active Employees Address
Employee's Current Address
Employee's Current Address Line 1
Employee's Current Address Line 2
Employee's Current Address Line 3
Current Address - Country
Current Address - State
Current Address - City
Current Address - Pincode
Employee's Home phone number
Employee's Mobile number
Employee's Work phone number
Office Phone number
Office Mobile number
Flag to indicate if the Current Address is same as Permanent Address. Eg. Yes - Current Address is the same as Permanent address No - Current Addrress is different from Permanent address
Employee's Permanent Address
Employee's Permanent Address Line 1
Employee's Permanent Address Line 2
Employee's Permanent Address Line 3
Permanent Address -Country
Permanent Address - State
Permanent Address - City
Permanent Address - Home Phone number
Permanent Address - Pincode
API to get the Employee Current Address
API to get the InActive Employees Address
Permanent Address - Country
To get the Employee personal Address Information
API to get the Personal information
Error Flag. True in case of error, False in case of Success.
Mobile Number of the Employee
Personal Email ID of the Employee
To get the family details of the employee
Salutation. Eg. Mr, Ms, Mrs, Dr, etc.,
Employee's Email ID
Dependent Name
Dependent Relationship. Eg. Father, Mother, Husband, Wife, Child, etc.,
Dependent's Date of Birth
API to get the details about the current medical insurance
API to get the details about the medical insurance
Medical Insurance Type I - Include E - Exclude
Name of Employee
To Upload workforce photo
Employee Photo
Flag to indicate the status of the transaction. Eg. S - Success , F - Failure
API to get Employee Details
Name of the Domain
Name of the Sub Domain
Name of the Market View Region
Name of the Market View Sub region
Base Country
Base City
Line of Business
Channel of Sales
Employee ID of the Reporting Manager
Personal Mail ID
Personal Mobile Number
Emergency Contact Name
Emergency Contact Number
Address
Reason for Hiring. Eg. New hire, Rejoining, Conversion
If Employee is a rejoinee, Old Employee ID will be provided.
Deprecated
Academic Qualification
Specialization
Institute
Year of Passing
Previous Employment Start Date. Eg. 10-Mar-2012
Previous Employment End Date. Eg. 12-Jan-2015
Previous Employer Name. Eg. XYZ Technologies
Previous Designation. Eg. Senior Manager , Technician, etc.,
API to Upload the employee data
Employee's Phone Number
Skype ID
Personal Email ID details
API to get the necessary data required to perform BGV
Workforce ID
First Name
Middle Name
Last Name
Gender
Workforce ID of Reporting Manager
Workforce ID of Skip Level Manager
Workforce Onboarded date in Workline
Status of the Workforce Eg. Y - Active , N - Inactive
Remarks
Address Details of workforce
Qualification of workforce
University
Medium of Instruction
Course Type
Course Appraisal
Industry
Current Employer
Other Employer
Current Notice Period
Years of Experience
API to get the document required to perform BGV of a Workforce
Workforce ID. Eg: W001345
Aadhar Document
Address Proof
Graduation Certificate
Resignation Letter
Salary Proof
Experience & Relieving Letter
API to update the results of background verification.
Status of BGV results . Eg: Recommended
BGV Reason
BGV Remarks
Verification status of BGV. Eg: Pending Or Completed
Verifier of BGV
Date of the background verification.
Additiional remarks
To upload Geo location coordinates in the system
Check In/ Out Date & Time Eg. 10-Apr-2019 11:50:21
Type of Attendance I - Check In O - Check Out
Additional Information
Geo coordinates - Latitude Eg. 19.0825
Geo coordinates - Longitude Eg. 72.741
Address of the Location
Additional description of the Location
Status of the Transaction Eg. True - Success, False - Error
API to upload the BioMetric information
Check In/ Out Date & Time Eg. 17-Apr-2019 11:50:21
To bulk upload employee attendance
Roster Date Eg. 12-Apr-2020
First Half Attendance P - Present A- Absent O - Weekly Off OD - Outdoor Duty H - Holiday WFH - Work From Home
Second Half Attendance P - Present A- Absent O - Weekly Off OD - Outdoor Duty H - Holiday WFH - Work From Home
To Get the Employees Roster Information
Entry Type Details will be provided based on this parameter. A - Based on Roster date M - Based on Attendance updated date
Roster Date Eg. 10-Oct-2019
Shift Name Format : G - General Shift, H - Holiday , O - Weekly Off
Roster Created Date Eg. 11-Oct-2019
Roster Updated Date Eg. 13-Oct-2019
API to get the Attendance Detail
EmployeeID
Roster Date. Eg. 10-Oct-2019
Shift Name. Format : G - General Shift, H - Holiday , O - Weekly Off
Attendance for the First half of the day. Eg. Y - Present , N - Absent
Attendance for the second half of the day. Eg. Y - Present , N - Absent
Check In time. Eg. 10:02:04
Check Out time. Eg. 21:09:34
Roster Updated Date. Eg. 13-Oct-2019
API to get the Attendance Data
Roster Date
Check In Date Eg. 11-Apr-2019
Check In Time Eg. 11-Apr-2019 10:10:52
Check In Time Eg. 11-Apr-2019 11:30:01
Check In Time Eg. 11-Apr-2019 15:00:33
Check In Time Eg. 11-Apr-2019 18:06:42
Leave Type, in case of leave Eg. CL, PL, SL
Check Out Time Eg. 11-Apr-2019 10:10:52
Check Out Time Eg. 11-Apr-2019 11:30:01
Check Out Time Eg. 11-Apr-2019 15:00:33
Check Out Time Eg. 11-Apr-2019 18:06:42
Check Out Date Eg. 12-Apr-2019
To bulk upload workforce roster swipe data into system
Password Credentials
Type of Attendance. I - Check In, O - Check Out
Result of the Upload Eg. True - Success False - Error message
Api to Upload swipe data
To bulk upload your workforce card swipe attendance details into the system
Additional Information from Device
To get the information about the Pending Reg Employee List
Workforce ID, i.e. the leave applicant. Eg: W001345
Attendance for the second half of the day Eg. Y - Present , N - Absent
Total Working Hours. Eg. 8
Type of Regularization Eg. Both Check in and Check out was missing, etc.,
Error Message. Eg. Invalid / Incomplete entries for parameter name
To get the information about the Pending Reg Manager List
Approvers Employee ID.Employee ID of approving authority. Eg. W93493S
Check In Time - From System
Check Out Time - From System
Status of Attendance - First half of the Day
Status of Attendance - Second half of the Day
Total Working Hours
Type of Regularization
Remarks provided by Employee for regularization
Reasons provided by Employee for regularization
To get the information about the regularization submitted by the Employee
Roster Date Regularization requested date Format : dd-MMM-yyyy Eg. 25-May-2019
Check in Time. Format: HH:mm. Eg. 9:10
Check out Time. Format: HH:mm. Eg. 19:15
Attendance for first half of the day.Eg. A - Absent, P-Present
Attendance for second half of the day. Eg. A - Absent, P-Present
Reason for regularization. Eg. Forgot to Swipe, Forgot to mark through system, Laptop under servicing, Not marked due to system problem
Source from which the request originates. Eg. Workline Bot, Workline Application ,Workline Mobile App, Workline WhatsApp, Third party App
To get the information about the regularization Approval by Manager
Roster Date Date for which the regularization was requested. Format : dd-MMM-yyyy Eg. 25-May-2019
Status of the regularization Eg. Approve, Reject
Regularization Approver remarks Eg. Rejected due to incorrect information, Approved, etc.,
Approver ID. Employee ID of approving authority. Eg. W93493S
To get the information about the Leave Cancellation List of the employee
Leave from date Date from which the leave will be observed.Format : dd-MMM-yyyy Eg. 10-Apr-2019
Leave to date Date until which the leave will be observed.Format : dd-MMM-yyyy Eg. 10-Apr-2019
Unique Reference ID of the leave entry.
To get the information about the Leave Cancellation
Key code Unique reference number of the leave application
Leave Cancellation reason Eg. Change of appointment, Rescheduled, etc.,
API to get the details about the leave approval
Key code.Unique reference number of the leave application
Remarks. Approver Remarks.Eg. Approved, Rejected due to incorrect information, etc.,
Action taken by the approving authority Eg. Approve, Reject
Approver ID.Employee ID of approving authority,Eg. W93493S
To get the project that are added
Project Start Date Eg. 18-May-2019
Project End Date Eg. 18-May-2024
Type of the Project Eg. Consulting, Solutioning , Services,etc.,
Market Segment of the Project Eg. Banking, Asset Management, etc.,
Name of the Client Eg. ABC Inc, XYZ Industries , etc.,
Business Unit which is linked to the Project Eg. Investment , Portfolio Management, etc.,
Unique reference ID for the project Eg. P83040, PO348392
Name of the Project Eg. Project Hanks , Code talkers , Xlabs, etc.,
Hours estimated for the Project Eg. 15000, 10000, etc.,
To get the sub project that are added
Name of the Sub Project.Eg. Foster Great Minds, HotJava, Sputnik, etc.,
Name of the Project.Eg. Project Hanks , Code talkers , Xlabs, etc.,
Status of the Sub Project.Eg. Y - Active , N- Inactive
To get the project details
Project Start Date. Eg. 18-May-2019
Project End Date. Eg. 18-May-2024
Type of the Project. Eg. Consulting, Solutioning , Services,etc.,
Market Segment of the Project. Eg. Banking, Asset Management, etc.,
Name of the Client. Eg. ABC Inc, XYZ Industries , etc.,
Business Unit which is linked to the Project. Eg. Investment , Portfolio Management, etc.,
Unique reference ID for the project. Eg. P83040, PO348392
Name of the Project. Eg. Project Hanks , Code talkers , Xlabs, etc.,
Hours estimated for the Project. Eg. 15000, 10000, etc.,
Status of the Project. Eg. Y - Active , N- Inactive
API to get information about time logs
To get the Sub Task List
Name of the Sub Task. Eg. Audit Analysis, Internal Recovery meet, etc.,
Name of the Task. Eg. Meetings , Internal Discussions, Audit, Design, etc.,
Denotes the status of the Sub Task. Eg. Y - Active , N - Inactive.
API to get details about the task
Name of the Task Eg. Meetings , Internal Discussions, Audit, Design, etc.,
Activate / Deactivate the Task Eg. Y - Active , N - Inactive
Link the Task to a Project or Business Unit
Provide Project Name or Business Unit Name Eg. AFK Functional Assurance , Investment Management, etc.,
API to get Sub Task Detail
Name of the Sub Task Eg. Audit Analysis, Internal Recovery meet, etc.,
Activate / Deactivate the Sub Task Eg. Y - Active , N - Inactive
To get the Task list
Denotes the status of the Task. Eg. Y - Active , N - Inactive
Flag to show whether the task is linked to Project or Business Unit. Eg. Project , Business Unit
Project Name or Business Unit linked to the Task. Eg. AFK Functional Assurance , Investment Management, etc.
To get the Details of workforce allocation
Workforce Allocation Start Date Eg. 05-Mar-2010
Workforce Allocation End Date Eg. 05-Mar-2023
Employee ID of the Project Manager Eg. W93923, E3492390, etc.,
Status of the Workforce allocation Eg. Y - Allocate, N- Deallocate
To get the details about the manager allocation
Project Manager Allocation Start Date Eg. 05-Mar-2010
Project Manager Allocation End Date Eg. 05-Mar-2023
Status of the Project Manager allocation Eg. Y - Allocate, N- Deallocate
To get the resource allocation details
Workforce ID. Eg. W892734, E93723, etc.,
Role of the Workforce in the specified project. Eg. Employee, Project Manager,etc.,
Status of the resource allocation. Eg. Y - Allocated, N- Deallocated
Unique reference ID for the resource allocation
To get the added Time Card details
Time Sheet Date.Eg. 10-May-2018
Name of the Task.Eg. Meetings , Internal Discussions, Audit, Design, etc.,
Name of the Sub Task.Eg. Audit Analysis, Internal Recovery meet, etc.,
Time spent on the specified task in hours.Eg. 3, 3.5, 4, 4.5, etc.,
Additional notes or description for the time entry.Eg. Research on new POC, Jailbreaking android devices, etc.,
API to get the time card pending list
To Date Details will be provided from this specific date. Format : dd-MMM-yyyy Eg. 10-Apr-2019
Workforce Name. Eg. William Faulkner, Sarojini Naidu, etc.,
Time Card Date. Eg. 11-Apr-2019
Name of the Sub Project. Eg. Foster Great Minds, HotJava, Sputnik, etc.,
Time spent on the specified task in hours. Eg. 3, 3.5, 4, 4.5, etc.,
Additional notes or description for the time entry. Eg. Research on new POC, Jailbreaking android devices, etc.,
API to approve time card
To get the detail about travel claim eligibility detail
Name of Account
Claim Applicapple
Maximum Amount Limit
Actual
To get the account details of expenses
Account Id
Get the detail about Eligiblity Detail
Expense Account ID Eg. E10102, E10103
Amount Limit
Expense Applicable
Warning,Restriction
At Actuals,Per Claim,Per Month
Level - 1 Auto Approval
Level - 1 Auto Approval Amount
Level - 2 Auto Approval
Level - 2 Auto Approval Amount
API to upload announcement
Announcement Title
Announcement Content
Date of publishing for the specified Announcement
Applicable to the Category Eg. Workforce, Alumini, Candidates, etc.,
Whether Announcement should be displayed in Home page Eg. Y- Yes, N- No
Whether the Announcement should be delivered to all Workforce Eg. Y- Yes , N - No
To get announcements
Applicable to the Category. Eg. Workforce, Alumini, Candidates, etc.,
Whether Announcement should be displayed in Home page. Eg. Y- Yes, N- No
Whether the Announcement should be delivered to all Workforce. Eg. Y- Yes , N - No
Status of the Announcement. Eg. Y- Active , N - Inactive
To push the notification details
Workforce ID.Eg. W892734, E93723, etc.,
Notification Message. Eg. Below items are pending for your action, etc.,
Notification Type. Eg. A - Action , M - Message
Status of the Notification. Eg. Y- Active , N - Inactive
API to get notifications
From Date.Details will be provided from this specific date. Format : dd-MMM-yyyy Eg. 10-Apr-2019
To Date.Details will be provided from this specific date. Format : dd-MMM-yyyy.Eg. 10-Apr-2019
API to add ticket to employee
Problem Group.Eg. Facilities , Attendance & Leave, etc.,
Problem Category. Eg. Asset Repair, Error in Attendance, etc.,
Problem Statement. Eg. Seat not allocated to me, etc.,
API to add the application
Application Name. Eg. Project Management, Payroll Systems, etc.,
Product Name.Eg. Micro loans, Mutual Funds, etc.,
Category of the Application.Eg. Internal , External, etc.,
Is Application Integrated?. Eg. Y- Yes, N- No
API to add access role to system
Role Name in the Application. Eg. Admin, Manager, etc.,
Denotes if there any Conflicting roles. Eg. Employee, Payroll Processor, etc.,
API to get information about the application access grid
API to add survey
Name of the Survey. Eg. World Environment Day, Did you know, etc.,
Section of the Survey. Eg. Earth, Sun , etc.,
Question Number. Eg. 1, 2, 3, etc.,
Question. Eg. Which country is the global host of this year's World Environment Day?, etc.,
Options. Eg. Sweden, Britain, China, etc.,
API to get the active employees CTC
Employee's CTC Amount
Effective From Date. Eg. 12-May-2019
API To get the pay sheet
Year Eg. 2019
Pay group for which the details are required. Eg. 8888
Pay sheet Information
API to add consultant
Consultant ID Eg. CX38249, GT9488, etc.,
Consultant Name Eg. Martin Luther King , JRR Tolkien, etc.,
Consultant Email ID Eg. abking@in.co, etc.,
UserName for Consultant Login Eg. abking1456, inte34356, etc.,
Flag to Enable login for the Consultant Eg. Y- Enable , N - Disable
This API can be used to send the details of Inactive Officer from another application. Details will be stored in Workline application and further processing will continue from thereon.
Inactivity alert trigger date.
Inactivity detection reason
ReferenceNo. Unique reference number to indicate the inactivity detected by the application.
Current status of the Officer
Access Token. This token should be generated using Access Token Generation API.
success message after activity
To verify if an account number belongs to any Workforce within the organization
Bank Account Number
Bearer Token for authentication
Name of the domain
IFSC Code
Mobile number that attached to the bank account
Checking whether the Account is present or not
API to onboard user in Active directory
API to get information about exit user from AD
Unique User Name for Authentication.
Password for Authentication.
API to get information about Absconding user's from AD
API to get Head of the Department list
Head of the Department - Employee ID
Head of the Department - Employee Name