Overview

Freshteam is a cloud based HR software that enables businesses to set up a branded HR portal that encompassess employee, recruitment, on-boarding, time-off, off-boarding, and organization details management.

You can use the Freshteam APIs to synchronize the employee directory maintained in Freshteam with any HR tool. Through APIs, you can access employee and organization information and respond to changes in the information when new employees are hired, appraisals are performed, promotions are meted out, policies are changed, employees are off-boarded, and so on.

Status and error messages

Freshteam uses the following standard HTTP status codes to indicate the success or failure of an API request.

  • 200 Success Request
  • 201 Created
  • 400 Bad Request
  • 401 Unauthenticated Request
  • 403 Forbidden
  • 404 Resource Not Found
  • 405 Method Not Allowed
  • 406 Not Acceptable
  • 415 Unsupported Media Type
  • 429 Too Many Requests
  • 500 Internal Server Request

A successful create request returns 201 Created along with the created object. A successful update request returns 200 OK along with the updated object. An unsuccessful API request returns a relevant HTTP status code along with an error response.

The error response

Example

1
2
3
4
5
6
7
8
{ "errors": [{ "code": "invalid_value", "message": "Value not present in system", "field": "leave_type_id" }] }

Attributes

errors (array of error object): All errors that cause the request to fail, specified as an array. Each array entry is an error object with the corresponding attributes.

Attributes of the error object
Attribute Name Data Type Description
code string

Descriptive error code that corresponds to the standard HTTP code.

Possible values:

  • invalid_credentials: (401) Incorrect or missing authentication or authorization credentials.
  • forbidden: (403) Inadequate role privilege to make the API request.
  • not_found: (404) Invalid request URL to access a resource.
  • method_not_allowed: (405) Invalid method in the API request. For example, a PUT /api/employees request returns this error.
  • invalid_accept_header: (406) Inavlid value for the Accept header parameter. Valid parameter values are application/json and */*.
  • invalid_content_type: (415) Invalid value for the Content-Type header parameter. Valid parameter value is application/json.
  • invalid_value: (400) Incorrect value or invalid format for an attribute value.
  • missing_value: (400) Missing value for a mandatory attribute.
  • duplicate_value: (400) Input attribute value is not unique for an attribute whose value must be unique.
  • datatype_mismatch: (400) Invalid data type for an attribute value.
  • internal_server_error: (500) Unexpected error caused from the Freshteam side.

message string Freshteam specific message that states the cause of the error.
field(displayed only for 400 Bad Request errors) string Identifies the attribute that causes the error.

Date and time literals

All system generated timestamps in the date-time format follow the Coordinated Universal Time (UTC) standard.
All attributes that accept or return data in the date format, follow the YYYY-MM-DD format.

Header parameters

Common request header parameters that are used in requests to Freshteam APIs are as follows:

  • Accept
  • Authorization
  • Content-Type

Accept

Specifies the accepted format of response. The parameter is used in the API request that is expected to return a response body.

Header parameter format

Accept: application/<format>

<format> is typically JSON and a parameter value of application/JSON specifies that the response must be a JSON object.
A parameter value of */* specifies that response data of any type is acceptable.

Authorization

Specifies the credentials required to authenticate and authorize an API request.

Header parameter format

Authorization: Bearer <access-token>

<access-token> is the value returned by a request call to the authentication server.

Content-Type

Specifies the format in which data is sent in the request body.

Header parameter format

Content-Type: application/<format>

<format> is typically JSON and a parameter value of application/JSON specifies that the request body is a JSON object.

Authentication and authorization

Freshteam uses Oauth 2.0 for authentication and authorization and the process involves the following steps:

  1. From the Freshteam UI, make a call to the Freshteam authentication server, to obtain an access token.
  2. Use the access token in further API requests, to make valid API calls.

In the Oauth 2.0 authentication scheme, the access token identifies a requester and the requester’s permissions.

Request call to obtain the access token
  1. Navigate to the Freshteam domain and click the profile icon on the right. A menu is displayed.
  2. Select API Settings. The API Settings window is displayed. The access token (obtained by a call to the authentication server) is displayed under Your API Key. You can copy and use the key in the authorization header parameter, to make valid API requests.

Rate limits

The permissible number of API calls in an hour is based on the Freshteam plan opted for an organization. The rate limit for each plan is based on the number of employees in the organization. The rate limit is applicable to an account, irrespective of the IP address from which calls originate.

Freshteam Plan Rate Limit (per hour)
Sprout Number of employees
Blossom 5 times the number of employees
Garden 5 times the number of employees
Estate 8 times the number of employees

Employees

Employees are members of the business or organization that uses Freshteam. An organization collects, stores, and updates all employee information through the records or fields in an employee information form. Freshteam offers a comprehensive list of default fields. An organization can also add custom fields. All field related information are grouped as employee fields.

Endpoints

GET /employees
POST /employees
GET /employees/{id}
PUT /employees/{id}
GET /employee_fields
POST /employee_fields

The employee object

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{ "id": 3000053373, "created_at": "2019-09-15T09:17:43.000Z", "updated_at": "2019-10-17T13:56:13.000Z", "deleted": false, "work_numbers": [ { "name": "Work", "number": "9716638376" } ], "nick_name": null, "date_of_birth": null, "gender": "male", "phone_numbers": [], "designation": null, "joining_date": "2019-09-25", "termination_date": null, "first_name": "Aditya", "middle_name": null, "last_name": "Sharma", "employee_id": "E001", "status": "active", "email": "aditya.sharma+2519@freshworks.com", "personal_email": null, "user_category": "regular", "branch": { "id": 3000011495, "created_at": "2019-09-15T09:17:43.000Z", "updated_at": "2019-09-25T06:42:39.000Z", "deleted": false, "name": "Default - Head office", "state": null, "city": "Chennai", "country_code": "IN", "zip": null, "time_zone": "Asia/Calcutta", "currency": "USD", "language": "en", "main_office": true, "date_format": "MonthFirst" }, "team": { "id": 3000043460, "created_at": "2019-09-15T09:17:43.000Z", "updated_at": "2019-09-15T09:17:43.000Z", "deleted": false, "name": "Business" }, "department": null, "sub_department": null, "job_role": { "id": 3000126932, "name": "Administration" }, "reporting_to": null, "hr_incharge": { "id": 3000053377, "first_name": "Langdon", "last_name": "Brennan (sample)", "email": "lbrennan@freshteam.com" }, "custom_field_values":{ "hobbies_cf_str01":null, "citizenship_cf_str02":{"id":0,"value":null} }, "shift": null }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the employee object, auto-generated when an employee’s information is saved. A successful create employee request, returns this attribute as part of the response object. Further API requests can use the returned value to identify an employee and update the employee information.
created_at string Timestamp of when the employee information is created, specified in the date-time format. The timestamp is returned as part of the response employee object, on successful processing of an employee create request.
updated_at string Timestamp of when the employee information is last updated, specified in the date-time format. The timestamp is returned as part of the response employee object, on successful processing of an employee create request. If an employee’s details are not updated, the updated_at and created_at values are same.
deleted boolean Specifies whether the employee information has been deleted from the Freshteam system.
Possible values: true, false.
work_numbers array of work number object Official phone numbers of the employee, specified as an array of work number object.
workstation_number string Work desk number of the employee.
nick_name string Alternate display name for the employee, in the Freshteam system.
date_of_birth string Birth date of the employee, specified in the date format.
gender string Gender of the employee.
Possible values: male, female.
address address object Residential address of the employee.
communication_address communication address object Address to which all official communication is sent.

Attributes of the CommunicationAddress object:
communication_street (string)
communication_city (string)
communication_state (string)
communication_country (string)
communication_zip_code (string)
same_as_residential (boolean): The attribute is part of the response object only if the attribute value is false.
designation string Job title of the employee.
phone_numbers array of phone number object Contact numbers of the employee, specified as an array of phone number objects.
joining_date string Date when the employee joins the organization, specified in the date format.
termination_date string Date when the employee leaves the organization, specified in the date format.
first_name Mandatory string Business name of the employee.
last_name Mandatory string Last name of the employee.
middle_name string Middle name of the employee.
employee_id string Employee ID provided by the organization that uses Freshteam.
status string Employment status of an employee.
Possible values:
draft: Current employee, record is being drafted.
active: Current employee, records are active and saved.
inactive: Employee is in a long leave of absence, records are archived.
terminated: Employee is no longer part of the organization, records are active.
deleted: Employee is no longer part of the organization, records are deleted.
email Mandatory string Official email address of the employee.
personal_email string Personal email address of the employee.
user_type string Employment terms that apply to the employee.
Possible values (enum): Full Time, Part Time, Contract, Internship, Temporary, Seasonal, Volunteer
branch branch object Branch to which the employee belongs.
reporting_to employee model object Details of the employee's reporting manager.
hr_incharge employee model object Details of the employee's HR manager.
team team object Details of the primary employee group (team) to which the employee belongs.
teams array of team object Details of the additional teams to which an employee belongs, specified as an array of team objects.
job_role job role object Department to which the employee belongs.
department department object Business function to which the employee belongs.
sub_department sub department object Subcategory of the job role to which the employee belongs.
awards array of award object All awards associated with the employee, specified as an array of award objects.
honors array of honor object All honorary titles associated with the employee, specified as an array of honour objects.
certificates array of certificate object All certificates awarded to the employee, specified as an array of certificate objects.
licenses array of license object Information from all license documents, specified as an array of license object.
bgv_details array of bgv detail object Background verification details, specified as an array of bgv details object.
government_documents array of government document object All details in the government documents uploaded by the employee, specified as an array of government documents object.
dependents array of dependent object All details of an employee’s dependents, specified as an array of dependent objects.
bank_accounts array of bank account object All details of the employee’s bank accounts, specified as an array of bank account objects.
prev_employments array of previous employment object All details of the employee’s previous employment positions, specified as an array of previous employment objects.
qualifications array of qualification object All details of the employee’s education, specified as an array of qualification objects.
compensation_details array of compensation detail object All details of the employee’s compensation, specified as an array of compensation detail objects.
bonuses array of bonus object All details of the employee’s various bonuses, specified as an array of bonus objects.
stocks array of stock object All details of the employee’s stock grant options, specified as an array of stock objects.
custom_field_values object The organization that uses Freshteam can configure custom fields to obtain additional employee information. This attribute contains the custom field names and corresponding values, as a valid JSON object of key (custom field name)-value (custom field’s value) pairs.
time_off array of employee time off object Leave of absence information of the employee, specified as an array of employee time off objects.
shift shift object Work shift to which the employee belongs.

Attributes of the shift object:
id (number): Identifier of the shift object, auto-generated when the shift information is configured in the Freshteam system.
value (string): Descriptive identifier of the shift. For example, Day shift, Night shift, EMEA shift, and so on.

Attributes of the work number object

Attribute Name Data Type Description
name string Type of phone number.
Possible values (enum): Work, Office Ext., Mobile, Others
number string Official contact number of the employee.

Attributes of the address object

Attribute Name Data Type Description
street string Street name, PO Box number, apartment complex, building identifier, or any other similar component of the employee’s residential address.
Minimum length: 2 characters
Maximum length: 128 characters
city string City, district, town, or any other similar component of the employee’s residential address.
Minimum length: 2 characters
Maximum length: 128 characters
state string State, region, province, county, or any other sub component of the employee’s residential address.
Minimum length: 2 characters
Maximum length: 128 characters
country string Country name or code.
Minimum length: 2 characters
Maximum length: 128 characters
zip_code string ZIP or postal code.
Minimum length: 2 characters
Maximum length: 128 characters

Attributes of the phone number object

Attribute Name Data Type Description
name string Type of phone number.
Possible values (enum): Home, Main, Mobile, Others
number string Personal contact number of the employee.

Attributes of the employee model object

Attribute Name Data Type Description
id number Identifier of the employee object, auto-generated when an employee’s (HR manager or reporting manager) information is created in the Freshteam system. Must be valid employee.id value.
city string City, district, town, or any other similar component of the employee’s residential address.
Minimum length: 2 characters
Maximum length: 128 characters
first_name string Business name of the HR or reporting manager.
last_name string Last name of the HR or reporting manager.
email string Official email address of the HR or reporting manager.

Attributes of the award object

Attribute Name Data Type Description
id number Identifier of the award object, auto-generated when the award is created in the organization's Freshteam system.
name string Name of the award.
awarded_by string Name of the person who awards the employee.
deleted boolean Specifies whether the award category still exists in the system.
Possible values: true, false

Attributes of the honour object

Attribute Name Data Type Description
id number Identifier of the honour object, auto-generated when the honorary title is created in the organization's Freshteam system.
name string Name of the honorary title.
awarded_by string Name of the person who awards the employee with the honorary title.
deleted boolean Specifies whether the honorary title still exists in the system.
Possible values: true, false

Attributes of the certificate object

Attribute Name Data Type Description
id number Identifier of the certificate object, auto-generated when the certification details are created in the organization's Freshteam system.
name string Name of the certification.
awarded_by string Name of the entity that awards the certification to the employee.
deleted boolean Specifies whether the certification is still a valid certification for the organization.
Possible values: true, false

Attributes of the license object

Attribute Name Data Type Description
id number Identifier of the license object, auto-generated when the license category is created in the organization’s Freshteam system.
license_name string Name of the license that the employee holds. For example, Driver’s license.
license_id string Unique license number or identifier associated with an employee’s license.
restrictions string Constraints on the license, if any. For example, the jurisdiction in which the license holds good.
expiry_date string Date till when the license is valid, specified in the date format.
deleted boolean Specifies whether the license category still exists in the system.
Possible values: true, false

Attributes of the bgv detail object

Attribute Name Data Type Description
id number Identifier of the bgv detail object, auto-generated when a type of background verification is created in the organization’s Freshteam system.
status string Background verification status.
Possible values (enum): not_initiated, initiated, in_progress, completed, cancelled
initiation_date string Date when the background verification is initiated for an employee, specified in the date format.
completion_date string Date when the background verification is complete, specified in the date format.
notes string Any additional notes pertaining to the background verification.
deleted boolean Specifies whether the type of background verification still exists in the system.
Possible values: true, false

Attributes of the government document object

Attribute Name Data Type Description
id number Identifier of the government document object, auto-generated when the document’s details are saved in the Freshteam system.
document_name string Descriptive identifier of the document.
number string Unique identifier of the government document, typically printed on the document.
country_code string Country in which the government document is issued, specified as a character code.
issuing_authority string Name of the government authority that has issued the document.
issuing_date boolean Date when the document is issued, specified in the standard date format.
expiry_date string Date till when the document is valid, specified in the standard date format.
deleted boolean whether the government document is still a valid document accepted by the organization.
Possible values: true, false
document_type document type object Details pertaining to the type of document.

Attributes of the document type object:
id (number): Identifier of the document type object, auto-generated when the document type is created in the Freshteam system.
value (string): Descriptive identifier of the document type. For example, visa document.
position (number): Place for the document type in the list of document types.
deleted: Specifies whether the document type is still a valid document type for the organization. Possible values: true, false

Attributes of the dependent object

Attribute Name Data Type Description
id number Identifier of the dependent object, auto-generated for each set of dependent information saved in the Freshteam system.
name string Full name of the dependent.
relationship string Relationship of the dependent with the employee.
Possible values (enum): Parent, Father, Mother, Spouse, Husband, Wife, Child, Son, Daughter, Sibling, Brother, Sister.
date_of_birth string Date of birth of the dependent.
gender string Gender of the dependent.
Possible values (enum): male, female
deleted boolean Specifies whether the dependent information is deleted from the Freshteam system and exists only as historical data.
Possible values: true, false

Attributes of the bank account object

Attribute Name Data Type Description
id number Identifier of the bank account object, auto-generated for each set of bank account information saved.
name_as_per_account string Name of the account holder, according to the bank records.
bank_name string Name of the bank where the employee holds an account.
branch_code string Alphanumeric code of the branch where the employee holds an account, used for banking purposes such as electronic payment transfer.
account_number string Identifier of the employee’s bank account.
deleted boolean Specifies whether the account information is deleted from the Freshteam system and exists only as historical data.
Possible values: true, false

Attributes of the previous employment object

Attribute Name Data Type Description
id number Identifier of the previous employment object, auto-generated for each set of previous employment information saved.
company string Name of the employee’s previous organization.
start_date string Date when the employee started work with the previous organization.
end_date string Date till when the employee was with the previous organization.
role string Designation of the employee in the previous organization.
salary_value number Employee’s base salary in the previous organization.
other_salary_components string Compensation components, other than fixed base pay, in the employee’s salary at the previous organization.
description string Job description of the employee’s role in the previous organization.
deleted boolean Specifies whether the employee’s previous organization information still exists in the Freshteam system.
Possible values: true, false
references array of reference object References to people in the employee’s previous organization, who can corroborate the employee’s candidature, specified as an array.

Attributes of the reference object:
name (string): Official name of the person specified as a reference.
number (string): Contact number of the person specified as a reference.

Attributes of the qualification object

Attribute Name Data Type Description
id number Identifier of the qualification object, auto-generated for each set of education related information saved.
degree string Identifier of the qualification awarded to the employee at the end of a course.
course string Name of the course the employee takes to obtain a qualification.
start_date string Date when the employee starts the course.
end_date string Date till when the course is offered to the employee.
institue_name number Identifier of the institution where the employee undertakes the course.
grade_average string Cumulative average score of the employee, spanning the course period.
pass_out_date string Date when the employee actually completes the course.
deleted boolean Specifies whether the employee’s qualification information still exists in the Freshteam system.
Possible values: true, false
description string Description of the course.

The compensation detail object

Example

{"id": 20175, "deleted": false, "current": true, "effective_date": "2019-08-29", "currency": "USD", "annual_amount": 60000, "pay_rate_value": 30000, eligible_work_hours": 30, "other_components": "Eligible for Sodexo, Insurance, and Travel allowance", "variable_pay": 20, "variable_pay_details": "30 percent of basic", "description": "VPComp1",
"reason": { "id": 66, "value": "Completed Intro Period"},
"cost_center": { "id": 51, "value": "Costcenter 1"},
"pay_group": { "id": 19, "value": "Pay Group 1"},
"pay_method": { "id": 16, "value": "Direct Deposit"},
"work_hour_rate": { "id": 59, "value": "Per Day"},
"pay_rate": { "id": 6, "name": "Weekly"},
"pay_schedule": { "id": 3, "name": "Quarterly"},
"variable_pay_frequency": { "id": 6, "name": "Weekly"}
}

Attributes

Attribute Name Data Type Description
id number Identifier of the compensation detail object, auto-generated for each set of compensation related information saved.
deleted boolean Specifies whether a specific set of compensation information still exists in the Freshteam system.
Possible values: true, false
current boolean Specifies whether a specific set of compensation information is the employee’s current compensation.
Possible values: true, false
effective_date string Date from when a specific compensation structure is effective.
currency string Currency in which the compensation is payable, specified as a valid three-character ISO currency code.
annual_amount number Annual compensation for the employee.
reason compensation reason object Reason for the existing or modified compensation.

Attributes of the compensation reason object:
id (number): Identifier of the compensation reason object, auto-generated when the reason is configured in the Freshteam system.
value (string): Descriptive identifier of the reason for the compensation. For example, Completion of probation period, Annual appraisal hike, and so on.
description string Summary of the employee’s compensation.
cost_center cost center object Cost group to which the employee belongs.
Employees are grouped into departments, teams, business units, sub-departments, and cost centers. All organization expenditure specific to the employee is borne by the cost center to which the employee belongs.

Attributes of the cost center object:
id (number): Identifier of the cost group to which the employee belongs, auto-generated when the cost center information is configured in the Freshteam system.
value (string): Descriptive identifier of the cost center.
pay_rate_value number Amount payable to the employee for a specific unit of time (identified by pay_rate), in the specified currency.
For example, if an employee is eligible for 250 INR hourly, pay_rate_value is 250, currency is INR, and pay_rate is hourly.
pay_rate pay rate object Unit of time for which the amount identified by pay_rate_value is applicable to the employee.

Attributes of the pay rate object:
id (number): Identifier of the pay rate object, auto-generated when the information is configured in the Freshteam system.
value (string): Descriptive identifier of the duration. For example, hourly, weekly, bi-weekly, and so on.
pay_schedule pay rate object Unit of time for which the amount identified by pay_rate_value is applicable to the employee.

Attributes of the pay rate object:
id (number): Identifier of the pay rate object, auto-generated when the information is configured in the Freshteam system.
value (string): Descriptive identifier of the duration. For example, hourly, weekly, bi-weekly, and so on.
pay_schedule pay rate object Unit of time for which the amount identified by pay_rate_value is applicable to the employee.

Attributes of the pay rate object:
id (number): Identifier of the pay rate object, auto-generated when the information is configured in the Freshteam system.
value (string): Descriptive identifier of the duration. For example, hourly, weekly, bi-weekly, and so on.
pay_group pay group object Payment processing group to which the employee belongs. Employees in an organization can be grouped based on payment factors such as, pay out frequency, annual amount, and so on.

Attributes of the pay group object:
id (number): Identifier of the pay group object, auto-generated when the pay group is configured in the Freshteam system.
value (string): Descriptive identifier of the pay group. For example, C-level.
pay_method pay method object Mode by which the compensation component is disbursed to the employee.

Attributes of the pay method object:
id (number): Identifier of the pay method object, auto-generated when the payment mode is configured in the Freshteam system.
value (string): Descriptive identifier of the payment mode. For example, Paycheck, Cash, Direct Deposit, and so on.
eligible_work_hours number Number of hours the employee typically works, specified in units of day, week, month, or year.
For example, if an employee is eligible to work for 8 hours every day, 8 is the eligible_work_hours value and per day is the work_hour_rate value.
work_hour_rate work hour rate object Mechanism by which the number of hours the employee works is aggregated.

Attributes of the work hour rate object:
id (number): Identifier of the work hour rate object, auto-generated when the aggregation mechanism is configured in the Freshteam system.
value (string): Descriptive identifier of the work hour rate. For example, Per week, Per month, Per day, and so on.
other_components string Additional information on compensation.
pay_factor string Percentage of the actual compensation that is declared as variable pay.
variable_pay number Variable pay amount the employee is eligible for.
variable_pay_frequency variable pay frequency object Frequency at which the organization pays the variable pay to the employee.

Attributes of the variable pay frequency object:
id (number): Identifier of the variable pay frequency object, auto-generated when the information is configured in the Freshteam system.
value (string): Descriptive identifier of the payout frequency. For example, annually, monthly, quarterly, and so on.
variable_pay_details number Additional information pertaining to variable pay.

Attributes of the bonus object

Attribute Name Data Type Description
id number Identifier of the bonus object, auto-generated for each set of bonus related information saved.
effective_date string Date by when the bonus component is payable.
value string Bonus amount payable to the employee.
currency string Currency in which the bonus is payable, specified as a valid three-character ISO currency code.
bonus_type bonus type object Reason for the bonus payout to the employee.

Attributes of the bonus type object:
id (number): Identifier of the bonus type object, auto-generated when the bonus reason is created in the Freshteam system.
value (string): Descriptive identifier of the bonus reason. For example, New hire bonus, Performance bonus, Transfer bonus, and so on.
position (number): Place of the bonus type in the list of bonus types.
deleted (boolean): Specifies whether the bonus type still exists in the Freshteam system. Possible values: true, false
additional_details string Additional information pertaining to the bonus payout.
deleted boolean Specifies whether a specific bonus component is still valid for the employee.
Possible values: true, false

The stock object

Example

{ "id": 1, "deleted": false, "grant_date": "2019-08-20", "grant_number": 20, "expiration_date": "2019-08-23", "currency": "USD", "total_stock_units": 20, "exercise_price": 70, "exercise_price_discount": 7, "value_per_share": 27, "with_in_range": true, "vesting_type": 2, "effective_date": "2019-08-21", "vesting_period": 20, "vesting_schedule": "weeks", "vesting_rate": 20, "description": "Notes",
"grant_reason": { "id": 55, "value": "Promotion" },
grant_type": { "id": 61, "value": "RSU" },
"pay_rate": { "id": 6, "name": "Weekly" }
}

Attributes

Attribute Name Data Type Description
id number Identifier of the stock object, auto-generated for each set of stock grant information saved.
deleted boolean Specifies whether a specific stock grant information is still valid for the employee.
Possible values: true, false
grant_date string Date from when the stock option is valid (effective date).
grant_number number Identifier of grant certificate provided to the employee.
grant_reason stock grant reason object Reason for providing the stock option to the employee.

Attributes of the stock grant reason object:
id (number): Identifier of the stock grant reason object, auto-generated when the reason is created in the Freshteam system.
value (string): Descriptive identifier of the grant reason. For example, Performance appraisal, Promotion, and so on.
position (number): Place of the grant reason in the list of grant reasons.
deleted (boolean): Specifies whether the grant reason is still a valid reason to allocate stocks to employees. Possible values: true, false
grant_type grant type object Type of stock benefit granted to the employee.

Attributes of the grant type object:
id (number): Identifier of the grant type object, auto-generated when the grant type is created in the Freshteam system.
value (string): Descriptive identifier of the grant type. For example, ESOP (options to purchase stocks), RSU (restricted stock units as part of compensation benefits), Phantom stocks, SAR (stock appreciation rights), and so on.
position (number): Place of the grant type in the list of grant types.
deleted (boolean): Specifies whether the grant type is still a valid method to grant stocks to employees. Possible values: true, false
expiration_date string Date by when the stock option provided to the employee expires.
For example, if an employee with ESOP options doesn’t exercise the option to purchase stocks by the expiration_date, the option expires. Similarly, if the employee doesn’t meet the performance standards to realize the restricted stock units allocated, by the expiration_date, the stock allocation expires.
currency string Currency in which the stock can be realized, specified as a valid three-character ISO currency code.
total_stock_units number Total number of stock units granted to the employee as options, restricted stock units, and so on.
exercise_price number Price at which the employee stock option plan states that the employee can purchase stocks.
exercise_price_discount number Discount on the actual market price, that dictates the exercise_price at which the employee can purchase stocks.
value_per_share number Actual market price of a stock unit or a corresponding fair market valuation of the stock unit.
vesting_type number Identifier of the vesting plan defined for the employee. The vesting period (time the employee has to wait to realize the stock grants entirely) depends on the vesting_type.
Possible values (enum): 1 (custom vesting plan), 2 (stock based vesting plan)
effective_date string Start date of the vesting period.
vesting_period string Measure of time associated with vesting_period.
Possible values (enum): years, months, weeks, days, and hours
vesting_schedule number Number of hours the employee typically works, specified in units of day, week, month, or year.
For example, if an employee is eligible to work for 8 hours every day, 8 is the eligible_work_hours value and per day is the work_hour_rate value.
vesting_rate integer Vesting frequency that specifies how often the stocks vest over the vesting_period, starting from the effective_date.
For example, if the vesting frequency in 25 % annually, 25 is the vesting_rate and annually is the pay_rate. It means the employee has to wait for 4 years to vest the stock grants entirely, provided all other vesting criteria (such as performance) are met.
pay_rate pay rate object Unit of time over which the vesting_rate is repeatedly applicable.

Attributes of the pay rate object:
id (number): Identifier of the pay rate object, auto-generated when the information is configured in the Freshteam system.
value (string): Descriptive identifier of the duration. For example, hourly, weekly, bi-weekly, and so on.

Attributes of the employee timeoff object

Attribute Name Data Type Description
leave_type timeoff type model object Type of leave the employee is eligible to take.

Attributes of the timeoff type model object:
id (number): Identifier of the timeoff type object, auto-generated when a time-off type is configured in the system. Must be a valid time_off_type.id value.
value (string): Descriptive identifier of the time-off type. Must be a valid time_off_type.name value. For example, Sick, Earned, and so on.
leaves_availed number Number of leaves the employee has taken under a specific leave category.
leave_credits number Number of leaves the employee is eligible to take, under a specific leave category.

The create employee object

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{ "first_name": "John", "middle_name": "L", "last_name": "Smith", "email": "john@freshteam.com", "role_ids": [ 3000060416 ], "employee_id": "E001", "personal_email": "john@new.com", "work_numbers": [ { "name": "Work", "number": "9716638376" } ], "phone_numbers": [], "date_of_birth": "1993-08-03", "designation": "Developer", "joining_date": "2018-06-25", "branch_id": 3000011496, "hr_incharge_id": 3000053377, "reporting_to_id": 3000053373, "department_id": 3000016570, "sub_department_id": null, "shift_id": 430461, "job_role_id": 3000129089, "team_id": 3000047560, "level_id": 3000056483, "blood_group": "", "gender": "male", "address": { "street": "101 SP Apts", "city": "Bangalore", "state": "Karnataka", "country": "India", "zip_code": "7001" }, "communication_address": { "communication_street": "2950 Firstwood street", "communication_city": "San Mateo", "state": "CA", "country": "US", "zip_code": "94403", "same_as_residential": true }, "custom_fields": { "hobbies_cf_str01": null}, "draft": false, "send_invite_email": false }
EXPAND ↓
Attributes
Attribute Name Data Type Description
first_name Mandatory string Business name of the employee.
middle_name string Middle name of the employee.
last_name Mandatory string Last name of the employee.
email Mandatory string Official email address of the employee.
role_ids Mandatory array of integer Identifiers of all roles associated with the employee, specified as an array of valid role.id values.
employee_id integer Employee ID provided by the organization that uses Freshteam.
personal_email string Personal email address of the employee.
work_numbers array of work number object Official phone numbers of the employee, specified as an array of work number object.
phone_numbers array of phone number object Contact numbers of the employee, specified as an array of phone number objects.
date_of_birth string Birth date of the employee specified in the date format.
designation string Job title of the employee.
Maximum permissible length: 128 characters
joining_date string Date when the employee joins the organization, specified in the date format.
branch_id number Identifier of the branch to which the employee belongs. Must be a valid branch.id value.
hr_incharge_id number Identifier of the person assigned as the hr incharge of the employee. Must be a valid employee.id value.
reporting_to_id number Identifier of the person assigned as the reporting manager of the employee. Must be a valid employee.id value.
department_id number Identifier of the business function to which the employee belongs. Must be a valid department.id value.
sub_department_id number Identifier of the subcategory of the job role to which the employee belongs. Must be a valid sub_department.id value.
shift_id number Identifier of the shift to which the employee belongs. Must be a valid shift.id value.
job_role_id number Identifier of the department to which the employee belongs. Must be a valid job_role.id value.
team_id number Identifier of the primary group to which the employee belongs. Must be a valid team.id value.
level_id number Identifier of the job band to which the employee belongs. Must be a valid level.id value.
blood_group string Blood group of the employee.
Possible values (enum): A−, B−, O−, B+, O+, A+, A1+, A1B-, AB+, AB-, A1B+, A2+, A2B-, A2B+, A1-
gender string Gender of the employee.
Possible values: male, female.
address address object Residential address of the employee.
communication_address communication address object Address to which all official communication is sent.

Attributes of the communication address object:
communication_street (string)
communication_city (string)
communication_state (string)
communication_country (string)
communication_zip_code (string)
same_as_residential (boolean)
custom_fields array of object All custom field names and corresponding values, specified as a valid JSON object of key (custom field name)-value(custom field’s value) pairs. The custom field name must be a valid employee_field.name value. The data type of the custom field's value depends on the type of the custom field. For example, if the custom field is a text field, the custom field's value is a string. If the custom field is a checkbox, the value is 0 or 1.
For more information, see the Supported field_type values.
draft boolean Specifies whether the employee information created is retained in the draft mode or saved for further processing.
Possible values (enum): true, false
send_invite_email boolean Specifies whether an email is sent to the employee inviting the employee to the Freshteam system, when the employee information is configured.
Possible values (enum): true, false

The employee field object

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{ "id":860161, "created_at":"2019-09-15T09:17:45.000Z", "updated_at":"2019-09-15T09:17:45.000Z", "employee_form_id":3000008188, "name":"basic_info", "label":"General Information", "field_type":"field_group", "position":1, "default":true, "viewable_by":"all", "editable_by":"self", "tab":"personal", "field_scopes":[] }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the employee field object, auto-generated when a new field is configured for an employee information form.
created_at string Timestamp of when the field is created, specified in the date-time format.
updated_at string Timestamp of when the field details are last modified, specified in the date-time format.
deleted boolean Specifies whether the field is still a valid field in the employee information form.
Possible values: true, false.
employee_form_id integer Identifier of the employee form in which the employee fields are present.
name string Namespace identifier of the section where the employee field is present.
For example, basic_info, additional_info, and so on.
label string Display name of the employee field.
field_type string Type of the employee field. The different field types are predefined in the Freshteam system. The field_type for all sections in the employee form is field_group.
Possible values (enum): See, supported field_type values.
position integer Position of the employee field in the employee form. The numbering is from left to right and top to bottom.
required boolean Specifies whether the employee field is a mandatory field.
default boolean Specifies whether an employee field is a default field in the Freshteam system.
For all custom fields, this attribute value is false. Possible values: true, false
viewable_by string View permissions for the employee field. View permissions are set at the section level. Only fields of the field_group type have a corresponding viewable_by field.
Possible values (enum):
all: All users of the Freshteam account can view the employee field values.
self: Only the employee can view the values.
hr: Only the HR associated with the employee can view the values.
self_hr: The employee, the employee’s HR, and the employee’s reporting manager can view the values.
editable_by string Edit permissions for the employee field. Edit permissions are set at the section level. Only fields of the field_group type have a corresponding editable_by field.
Possible values (enum):
self: Only the employee can edit the values.
hr: Only the HR associated with the employee can edit the values.
tab string Name of the tab on the employee form, under which the employee field (section) is present. Only fields of the field_group type have a corresponding tab field.
section_label string Display name of the section to which the employee field belongs. Only fields whose field type is not field_group have a corresponding section_label field.
field_scopes array of field scope object Employee groups to which the employee field is applicable.

Attributes of the field scope object:
id (integer): Identifier of the field scopes object, auto-generated when the applicability information is configured for a section on the employee form.
scopable_type (string): Identifier of the employee group to which the section is applicable. For example, team, department, branch, level, and so on.
scopable_id (number): Identifier of the sub-group to which the section is applicable.

For example, if a section on the employee form is applicable to the Business (teams.id is 3000043460), Corporate Marketing (teams.id is 3000043467), and Customer Success (teams.id is 3000043462) teams, the corresponding field_scopes attribute is as follows:

"field_scopes":[ {"id":32,"scopable_type":"teams","scopable_id":3000043460}, {"id":33,"scopable_type":"teams","scopable_id":3000043467}, {"id":34,"scopable_type":"teams","scopable_id":3000043462} ]

Supported field_type values

When creating or updating employee information, appropriate values are specified for the custom fields (create_employee.custom_field). A valid custom field value must be of the data type corresponding to the field type (employee_field.field_type). The supported field_type values (and corresponding data types) are as follows:

  • text (string)
  • dropdown (string)
  • email (string)
  • phone_number (string)
  • checkbox (boolean - 0, 1)
  • paragraph (string)
  • date_time (string)
  • number (number)
  • url_set (string)
  • url (string)
  • attachment (number)
  • radio (string)
  • label (string)
  • field_group (string)
  • emergency_contact (object)
  • phone_number_set (object)
  • social_profile (array)
  • address (object)
  • previous_employment (object)
  • education (object)
  • avatar (string)
  • bank_details (object)
  • compensation (object)
  • standard_email (string)
  • standard_dropdown (string)
  • standard_multi_dropdown (array)
  • file_input (string)
  • visa (object)
  • bg_verification (object)
  • government_id (object)
  • licenses (object)
  • certifications (object)
  • awards (object)
  • honours (object)
  • comp_bonuses (object)
  • stock_grants (object)
  • dependents (object)
  • time (string)
  • personal_contact_set (object)

The create employee field object

Example
1
2
3
4
5
6
{ "label": "Hobbies", "required": false, "section_name": "additional_info", "field_type": "text" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
label Mandatory number Display name of the custom field.
required boolean Specifies whether the custom field is a mandatory employee field.
Possible values: true, false
section_name Mandatory string Namespace identifier of the section where the custom field is created. Must be a valid employee_field.name value.
field_type string Specifies the type of the custom field.
Possible values (enum): text, number

List all employees

Retrieves a list of all employees whose details are configured in the Freshteam system.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

get
/api/employees
Query parameters

You can use a combination of the following query parameters to limit or filter the bulk response data. Ensure that the query parameter values are URL encoded.

Parameter Name Description Example
status Limits the response to employee objects whose status value matches the parameter value.
Valid values: active, inactive

GET /api/employees?status=active

first_name Limits the response to employee objects whose first_name value matches the parameter value.

GET /api/employees?first_name=Dreda

last_name Limits the response to employee objects whose last_name value matches the parameter value.

GET /api/employees?last_name=Dreda

personal_email Limits the response to employee objects whose personal_email value matches the parameter value.

GET /api/employees?personal_email=dreda%40gmail.com

work_email Limits the response to employee objects whose email value matches the parameter value.

GET /api/employees?work_email=lbrenan%40freshteam.com

department Limits the response to employee objects whose department.id value matches the parameter value.

GET /api/employees?department=3000016570

location Limits the response to employee objects whose branch.id value matches the parameter value.

GET /api/employees?location=3000011495

reporting_manager Limits the response to employee objects whose reporting_to.id value matches the parameter value.

GET /api/employees?reporting_manager=3000053373

updated_since

Should be a date-time value in the UTC standard.
Limits the response to employee objects whose updated_at value is a time after the parameter value.

GET /api/employees?updated_since=2019-12-06T06:00:33.000Z

sort Specifies the field based on which the response data is sorted.
Valid values: first_name, last_name, employee_id

GET /api/employees?sort=first_name

sort_type If the sort value is specified, sort_type specifies whether the list must be sorted in ascending or descending order. If sort_type is specified with no sort value, the list is sorted based on the first_name attribute.
Valid values: asc, desc

GET /api/employees?sort=first_name&sort_type=asc

Example to retrieve all the details of the employees in branches 3000011495 and 3000011496 and sort the information in ascending order of first names:

GET /api/employees?location=3000011495,3000011496&sort=first_name&sort_type=asc

Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/employees" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all employees’ details, as an array. Each array entry is an employee object with the corresponding attributes. The response data is limited by the query and pagination parameters passed in the request.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
[ {"id":3000053373, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-11-07T08:49:41.000Z", "deleted":false, "work_numbers": [ {"name":"Work","number":"9716638376"} ], "nick_name":null, "date_of_birth":null, "gender":"male", "phone_numbers":[], "designation":null, "joining_date":"2019-09-25", "termination_date":null, "first_name":"Aditya", "middle_name":null, "last_name":"Sharma", "employee_id":"E001", "status":"active", "email":"aditya.sharma+2519@freshworks.com", "personal_email":null, "user_category":"regular", "branch": {"id":3000011495, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-25T06:42:39.000Z", "deleted":false, "name":"Default - Head office", "state":null, "city":"Chennai", "country_code":"IN", "zip":null, "time_zone":"Asia/Calcutta", "currency":"USD", "language":"en", "main_office":true, "date_format":"MonthFirst" }, "team": {"id":3000043460, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-15T09:17:43.000Z", "deleted":false, "name":"Business" }, "department":null, "sub_department":null, "job_role": {"id":3000126932, "name":"Administration" }, "reporting_to":null, "hr_incharge": {"id":3000053377, "first_name":"Langdon", "last_name":"Brennan (sample)", "email":"lbrennan@freshteam.com" }, "shift":null }, {"id":3000061324, "created_at":"2019-11-02T04:36:27.000Z", "updated_at":"2019-11-02T04:40:03.000Z", "deleted":false, "work_numbers":[], "nick_name":null, "date_of_birth":null, "gender":null, "phone_numbers":[], "designation":null, "joining_date":null, "termination_date":null, "first_name":"Admin", "middle_name":null, "last_name":"User", "employee_id":null, "status":"active", "email":"ft_employee2@freshhr.com", "personal_email":null, "user_category":"regular", "branch": {"id":3000011495, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-25T06:42:39.000Z", "deleted":false, "name":"Default - Head office", "state":null, "city":"Chennai", "country_code":"IN", "zip":null, "time_zone":"Asia/Calcutta", "currency":"USD", "language":"en", "main_office":true, "date_format":"MonthFirst" }, "team":null, "department":null, "sub_department":null, "job_role":null, "reporting_to":null, "hr_incharge":null, "shift":null } ]
EXPAND ↓

Create an employee

Creates an employee object based on the request body parameter. The request body parameter is a create employee object.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

post
/api/employees
Sample request | Curl
Copied Copy
1
2
3
4
5
6
7
curl -X POST "https://<account-name>.freshteam.com/api/employees" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ" -H "Content-Type: application/json" -d '{ "first_name": "John", "last_name": "Smith", "email": "john@freshteam.com", "role_ids": [ 3000060416 ] }'
EXPAND ↓
Sample response

A successful request returns 201 Created along with the created employee object. The object contains the id, created_at, and updated_at attributes. In further API calls, the id that is returned can be used to update the corresponding employee information or retrieve information.

Retrieve employee information

Identifies an employee by the id passed in the request and returns the corresponding information as an employee object.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

get
/api/employees/{id}
Path parameters
Parameter Name Data Type Description
idMandatory number The employee.id value that is auto-generated when an employee’s details are configured in the Freshteam system.
Query parameters

To restrict the response (payload) object size, certain attributes are not specified as part of the employee object by default. In the query string of the request URL, you can use the include query parameter, to retrieve the following employee object’s attributes.

  • compensation_details
  • stocks
  • bonuses
  • time_off
  • awards
  • bonuses
  • honors
  • certificates
  • licenses
  • background_verification_details
  • visas
  • government_documents
  • dependents
  • user_documents
  • bank_accounts
  • prev_employments
  • qualifications
  • teams
Example to include compensation_details in the response object:

GET /api/employees/3000053373?include=compensation_details

Example to include compensation_details and time_off in the response object:

GET /api/employees/3000053373?include=compensation_details,time_off

Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/employees/3000053373" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with the retrieved employee object.

Update employee information

Identifies an employee object by the id passed in the request and updates the object with the information specified in the request body. The request body parameter is a create employee object. If an attribute value is null or not passed as part of the request payload, the attribute’s existing value is retained.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

put
/api/employees/{id}
Path parameters
Parameter Name Data Type Description
idMandatory number The employee.id value that is auto-generated when an employee’s details are configured in the Freshteam system.
Sample request | Curl
Copied Copy
1
2
3
4
5
6
7
8
curl -X POST "https://<account-name>.freshteam.com/api/employees" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ" -H "Content-Type: application/json" -d '{ "first_name": "John", "middle_name":"L" "last_name": "Smith", "email": "john@freshteam.com", "role_ids": [ 3000060416 ] }'
EXPAND ↓
Sample response

A successful request returns 200 OK along with the updated employee object.

List all employee fields

Retrieves a list of all default and custom employee fields configured for an organization, in the Freshteam system.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

get
/api/employee_fields
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/employee_fields" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all employee fields’ details, as an array. Each array entry is an employee field object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
[ {"id":3000053373, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-11-07T08:49:41.000Z", "deleted":false, "work_numbers": [ {"name":"Work","number":"9716638376"} ], "nick_name":null, "date_of_birth":null, "gender":"male", "phone_numbers":[], "designation":null, "joining_date":"2019-09-25", "termination_date":null, "first_name":"Aditya", "middle_name":null, "last_name":"Sharma", "employee_id":"E001", "status":"active", "email":"aditya.sharma+2519@freshworks.com", "personal_email":null, "user_category":"regular", "branch": {"id":3000011495, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-25T06:42:39.000Z", "deleted":false, "name":"Default - Head office", "state":null, "city":"Chennai", "country_code":"IN", "zip":null, "time_zone":"Asia/Calcutta", "currency":"USD", "language":"en", "main_office":true, "date_format":"MonthFirst" }, "team": {"id":3000043460, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-15T09:17:43.000Z", "deleted":false, "name":"Business" }, "department":null, "sub_department":null, "job_role": {"id":3000126932, "name":"Administration" }, "reporting_to":null, "hr_incharge": {"id":3000053377, "first_name":"Langdon", "last_name":"Brennan (sample)", "email":"lbrennan@freshteam.com" }, "shift":null }, {"id":3000061324, "created_at":"2019-11-02T04:36:27.000Z", "updated_at":"2019-11-02T04:40:03.000Z", "deleted":false, "work_numbers":[], "nick_name":null, "date_of_birth":null, "gender":null, "phone_numbers":[], "designation":null, "joining_date":null, "termination_date":null, "first_name":"Admin", "middle_name":null, "last_name":"User", "employee_id":null, "status":"active", "email":"ft_employee2@freshhr.com", "personal_email":null, "user_category":"regular", "branch": {"id":3000011495, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-25T06:42:39.000Z", "deleted":false, "name":"Default - Head office", "state":null, "city":"Chennai", "country_code":"IN", "zip":null, "time_zone":"Asia/Calcutta", "currency":"USD", "language":"en", "main_office":true, "date_format":"MonthFirst" }, "team":null, "department":null, "sub_department":null, "job_role":null, "reporting_to":null, "hr_incharge":null, "shift":null } ]
EXPAND ↓

Create a custom employee field

Creates a custom employee field, in an employee form, based on the request body parameter. The request body parameter (input payload) is a create employee field object.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

post
/api/employee_fields
Sample request | Curl
Copied Copy
1
2
3
4
5
6
curl -X POST "https://<account-name>.freshteam.com/api/employee_fields" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ" -H "Content-Type: application/json" -d '{"label": "Hobbies", "required": false, "section_name": "additional_info", "field_type": "text" }'
EXPAND ↓
Sample response

A successful request returns 201 Created along with the created employee field object. The object contains the id, created_at, and updated_at attributes in addition to the mandatory attributes. The section_label attribute (in the response object) is the display name of the section corresponding to the section_name attribute passed in the request body.

Branches

For an organization, the offices in different geographic locations are its branches. The organization that uses Freshteam can configure various branches and associate employees to a branch.

Endpoint

GET /branches

The branch object

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{ "id":3000011495, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-25T06:42:39.000Z", "deleted":false, "name":"Default - Head office", "state":null, "city":"Chennai", "country_code":"IN", "zip":null, "time_zone":"Asia/Calcutta", "currency":"USD", "language":"en", "main_office":true, "date_format":"MonthFirst" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the branch object, auto-generated when a new branch is configured in the Freshteam system.
created_at string Timestamp of when the branch is created for an organization, specified in the date-time format.
updated_at string Timestamp of when the branch details are last modified, specified in the date-time format.
deleted boolean Specifies whether the branch is still a valid location. An organization can relocate or consolidate branches, in which case the existing branch information is deleted from the Freshteam account but the branch details can still exist in the system as historical data. For such deleted branches, the deleted attribute is set as true.
Possible values: true, false
name string Descriptive identifier of the branch.
street string Address parameter of the branch.
state string Province in which the branch is located.
city string City in which the branch is located.
country_code string Country in which the branch is located, specified as a character code.
zip string Postal code of the region where the branch is located.
time_zone string Time-zone applicable to the branch location.
currency string Three-character valid ISO currency code.
language string Primary language at the branch location.
main_office boolean Specifies whether the branch is the main office at a location.
Possible values: true,false
date_format string Accepted date format at the region where the branch is located.
Possible values: MonthFirst (specifies that the accepted format is MM-DD-YYYY), DateFirst (specifies that the accepted format is DD-MM-YYYY)

List all branches

Retrieves a list of all branches configured for the organization that uses Freshteam.

get
/api/branches
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/branches" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all branches’ details, as an array. Each array entry is a branch object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
[ { "id":3000011496, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-15T09:17:43.000Z", "Deleted":false, "name":"Branch office", "State":null, "city":"San Francisco", "country_code":"US", "zip":null, "time_zone":null, "currency":"USD", "Language":"en", "Main_office":false, "date_format":"MonthFirst" }, {"id":3000011495, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-25T06:42:39.000Z", "Deleted":false, "name":"Default - Head office", "State":null, "city":"Chennai", "country_code":"IN", "Zip":null, "time_zone":"Asia/Calcutta", "currency":"USD", "Language":"en", "Main_office":true, "date_format":"MonthFirst" } ]
EXPAND ↓

Job roles

An organization is categorized into various departments based on the primary job roles in the organization. The high-level departments (job roles) are further divided into sub-departments.

Endpoint

GET /job_roles

The job role object

Example
1
2
3
4
5
6
7
{ "id":3000126932, "created_at":"2019-09-15T09:17:44.000Z", "updated_at":"2019-09-15T09:17:44.000Z", "Deleted":false, "name":"Administration" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the job role object, auto-generated when a new department is created in the Freshteam system.
created_at string Timestamp of when the department is created, specified in the date-time format.
updated_at string Timestamp of when the department name was last modified, specified in the date-time format.
deleted boolean Specifies whether the department still exists in the organization.
Possible values: true, false
name string Meaningful identifier of the department.

List all job roles (departments)

Retrieves a list of all departments into which an organization is split.

get
/api/job_roles
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/job_roles" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all departments’ details, as an array. Each array entry is a job role object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
[ { "id": 3000126932, "created_at": "2019-09-15T09:17:44.000Z", "updated_at": "2019-09-15T09:17:44.000Z", "deleted": false, "name": "Administration" }, { "id": 3000129089, "created_at": "2019-10-15T10:59:58.000Z", "updated_at": "2019-10-15T10:59:58.000Z", "deleted": false, "name": "Engineering" }, { "id": 3000126931, "created_at": "2019-09-15T09:17:44.000Z", "updated_at": "2019-09-15T09:17:44.000Z", "deleted": false, "name": "Finance" }, { "id": 3000126934, "created_at": "2019-09-15T09:17:44.000Z", "updated_at": "2019-09-15T09:17:44.000Z", "deleted": false, "name": "Human Resources" }, { "id": 3000126930, "created_at": "2019-09-15T09:17:44.000Z", "updated_at": "2019-09-15T09:17:44.000Z", "deleted": false, "name": "Marketing" }, { "id": 3000126933, "created_at": "2019-09-15T09:17:44.000Z", "updated_at": "2019-09-15T09:17:44.000Z", "deleted": false, "name": "Sales" } ]
EXPAND ↓

Sub-departments

In a Freshteam system, the various departments in an organization can be further classified into sub-departments and business functions.

Endpoint

GET /sub_departments

The sub-department object

Example
1
2
3
4
5
6
7
{ "id": 1, "created_at": "2019-07-05T10:04:56.000Z", "updated_at": "2019-07-05T10:04:56.000Z", "deleted": false, "name": "Freshteam" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the sub-department object, auto-generated when a new sub-department is created in the Freshteam system.
created_at string Timestamp of when the sub-department is created, specified in the date-time format.
updated_at string Timestamp of when the sub-department’s name was last modified, specified in the date-time format.
deleted boolean Specifies whether the sub-department is still a valid categorization in the organization.
Possible values: true, false
name string Descriptive identifier of the sub-department.

List all sub-departments

Retrieves a list of all sub-departments into which a department is split.

get
/api/sub_departments
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/sub_departments" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all sub-departments’ details, as an array. Each array entry is a sub-department object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
[ { "id": 1, "created_at": "2019-07-05T10:04:56.000Z", "updated_at": "2019-07-05T10:04:56.000Z", "deleted": false, "name": "Freshteam" } ]
EXPAND ↓

Teams

An organization forms various teams based on which employees can be grouped. The teams align to the various job functions the employees are expected to perform. An employee belongs to a primary team based on the employee’s primary job role and can be assigned to additional teams depending on the job profile.

Endpoint

GET /teams

The team object

Example
1
2
3
4
5
6
7
{ "id": 3000043460, "created_at": "2019-09-15T09:17:43.000Z", "updated_at": "2019-09-15T09:17:43.000Z", "deleted": false, "name": "Business" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the team object, auto-generated when a team is created in the Freshteam system.
created_at string Timestamp of when the team is created, specified in the date-time format.
updated_at string Timestamp of when the team name is last modified, specified in the date-time format.
deleted boolean Specifies whether the team is still a valid grouping in the organization. An organization can merge teams or form sub-teams, in which case the existing team is deleted from the Freshteam account but the team details can still exist in the system as historical data. For such deleted teams, the deleted attribute value is set to true.
Possible values: true, false
name string Descriptive identifier of the team. For example, Corporate Marketing, HR Operations, and so on.

List all teams

Retrieves a list of all employee teams configured for the organization that uses Freshteam.

get
/api/teams
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/teams" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all teams’ details, as an array. Each array entry is a team object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
[ {"id":3000043460, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-09-15T09:17:43.000Z", "deleted":false,"name":"Business" }, {"id":3000043467, "created_at":"2019-09-15T09:17:44.000Z", "updated_at":"2019-09-15T09:17:44.000Z", "Deleted":false, "name":"Corporate Marketing" }, ]
EXPAND ↓

Levels

The various job bands in an organization, which segregate the employees into a hierarchical structure, are the levels in the organization. The organization that uses Freshteam can configure levels and associate employees to a level.

Endpoint

GET /levels

The level object

Example
1
2
3
4
5
6
7
{ "id":3000056483, "created_at":"2019-09-15T09:17:44.000Z", "updated_at":"2019-09-15T09:17:44.000Z", "deleted":false, "name":"IC1" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of a level object, auto-generated when a level is created in the Freshteam system.
created_at string Timestamp of when the level is created, specified in the date-time format.
updated_at string Timestamp of when the level details are last modified, specified in the date-time format.
deleted boolean Specifies whether the level is still a valid hierarchy in the organization. An organization can merge levels or form new levels, in which case, the existing level is deleted from the Freshteam account but the level details can still exist in the system as historical data. For such deleted levels, the deleted attribute value is set to true.
Possible values: true, false
name string Descriptive identifier of the level. For example, IC2 (Individual contributor - 2), PM3 (Product manager -3) and so on.

List all levels

Retrieves a list of all levels configured for the organization that uses Freshteam.

get
/api/levels
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/levels" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all levels’ details, as an array. Each array entry is a level object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
[ { "id":3000056483, "created_at":"2019-09-15T09:17:44.000Z", "updated_at":"2019-09-15T09:17:44.000Z", "deleted":false, "name":"IC1" }, { "id":3000056484, "created_at":"2019-09-15T09:17:45.000Z", "updated_at":"2019-09-15T09:17:45.000Z", "deleted":false, "name":"IC2" }, { "id":3000056485, "created_at":"2019-09-15T09:17:45.000Z", "updated_at":"2019-09-15T09:17:45.000Z", "deleted":false, "name":"IC3" } ]
EXPAND ↓

Timeoffs

An organization can use Freshteam for time-off management. Timeoff types are the vacation types that are available for the employees in the organization. An employee can raise leave of absence requests. The request details are grouped as timeoffs.

Endpoints

GET /time_offs
POST /time_offs
GET /time_off_types
GET /time_off_types/{id}

The timeoff object

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{ "id":3000031566, "created_at":"2019-09-15T09:18:44.000Z", "updated_at":"2019-09-15T09:18:44.000Z", "user_id":3000053373, "start_date":"2019-01-01", "end_date":"2019-01-04", "status":"approved", "leave_units":3, "optional_leave_units":null, "leave_type_id":3000011436, "status_comments":null, "approved_by_id":null, "applied_by_id":3000053373, "cancelled_by_id":null, "rejected_by_id":null, "comments":"Hospital appointment", "rejected_at":null, "cancelled_at":null }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the timeoff object, auto-generated when a time-off request is saved.
created_at string Timestamp of when the time-off request is created, specified in the date-time format.
updated_at string Timestamp of when the time-off request details are last updated, specified in the date-time format.
start_date Mandatory string Starting date of the employee’s absence.
end_date Mandatory string Ending date of the employee’s absence.
status string Status of the time-off request.
Possible values (enum): pending, approved, declined, cancelled
leave_units integer Number of days of time-off applied through the time-off request, auto-generated considering the organization’s work and holiday calendars and the time-off request’s start_date and end_date.
optional_leave_units integer Number of days of optional holidays that falls within the time-off request period.
leave_type_id Mandatory integer Identifier the time-off type under which the time-off request is raised. Must be a valid time_off_type.id value
status_comments string Reason for declining or cancelling the time-off request.
approved_by_id integer Identifier of the employee who approves the time-off request. Must be a valid employee.id value.
applied_by_id integer Identifier of the employee who raises the time-off request.
cancelled_by_id integer Identifier of the employee who cancels the time-off request. Same as applied_by_id, if the time_off.status is cancelled.
rejected_by_id integer Identifier of the employee who declines the time-off request.
comments Mandatory string Reason quoted by the employee for the time-off request.
rejected_at string Timestamp of when the reporting manager or HR partner declines the time-off request.
cancelled_at string Timestamp of when the employee cancels the time-off request.

The create timeoff object

Example
1
2
3
4
5
6
7
8
9
10
{ "start_date": "2019-11-15", "end_date": "2019-11-17", "optional_leave_days": [], "notify_to": [], "add_to_calendar": false, "auto_decline_events": false, "leave_type_id": 3000011437, "comments": "Personal work" }
EXPAND ↓
Attributes
Attribute Name Data Type Description
start_date Mandatory string Starting date of the employee’s absence.
end_date Mandatory string Ending date of the employee’s absence.
optional_leave_days array of string Specifies the list of optional holidays that fall within the time-off request period, as an array. Each array entry is a date format value.
notify_to array of number Specifies the list of employees who are notified of the time-off request, as an array. Each array entry must be a valid employee.id value.
add_to_calendar boolean Specifies whether the time-off notice is added to the employee’s calendar automatically.
Valid values: true, false
auto_decline_events boolean Specifies whether all calendar events scheduled during the leave of absence are declined automatically.
Valid values: true, false
leave_type_id Mandatory integer Identifier of the time-off type under which the time-off request is raised. Must be a valid time_off_type.id value.
comments Mandatory string Reason for the time-off request.

The timeoff type object

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{ "id":3000011437, "created_at":"2019-09-15T09:18:43.000Z", "updated_at":"2019-09-15T09:18:43.000Z", "deleted":false, "name":"Earned", "description":"Earned Leave", "applicable_for":null, "default":true, "auto_approve":false, "auto_approve_after":null, "auto_approve_limit":null, "marital_status":null }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of the timeoff type object, auto-generated when a vacation type is configured.
created_at string Timestamp of when the time-off type is created, specified in the date-time format.
updated_at string Timestamp of when the time-off type details are last updated, specified in the date-time format.
deleted boolean Specifies whether the time-off type is still a valid vacation type in the Freshteam system.
Possible values: true, false
name Mandatory string Title of the time-off type.
description Mandatory string Notes about the time-off type.
applicable_for string Specifies the eligibility for the time-off type based on gender.
Possible values: male, female, all
default boolean Specifies whether the time-off type is available by default to all employees.
Possible values: true, false
auto_approve boolean Specifies whether the time-off requests under the time-off type are auto-approved or sent to HR partners and reporting managers for further approval.
Possible values: true, false
auto_approve_after number Number of days after which a time-off request that is pending approval is auto-approved.
auto_approve_limit number Number of time-off request days beyond which a time-off request is sent for approval. For example if auto_approve_limit is 4, all requests for more than 4 days of time-off are sent for approval.
marital_status string Specifies the eligibility for the time-off type based on marital status.
Possible values: all, single, married

List all timeoffs

Retrieves a list of all time-off requests from all employees in the organization.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

get
/api/time_offs
Query parameters

You can use a combination of the following query parameters to limit or filter the bulk response data.

Parameter Name Description Example
status Limits the response to time_off objects whose status value matches the parameter value.
Valid parameter values: pending, approved, declined, cancelled

GET /api/time_offs?status=pending

user Limits the response to time_off objects whose user_id value matches the parameter value.

GET /api/time_offs?user=3000053373

leave_type Limits the response to time_off objects whose leave_type_id value matches the parameter value.

GET /api/time_offs?leave_type=3000011436

location Limits the response to time-off requests that originate from a specific location, that is, requests from all employees whose branch.id value matches the parameter value. The employees are identified by applied_by_id.

GET /api/time_offs?location=3000011496

start_date Mandatory if the end_date filter is used. Limits the response to time_off objects whose start_date value matches the parameter value.

GET /api/time_offs?start_date=2019-09-17&end_date=2019-09-20

end_date Mandatory if the start_date filter is used. Limits the response to time_off objects whose end_date value matches the parameter value. Must be a value later than start_date.

GET /api/time_offs?start_date=2019-09-17&end_date=2019-09-20

Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/time_offs" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all time-off requests from all employees, as an array. Each array entry is a timeoff object with the corresponding attributes. The response data is limited by the query and pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
[ {"id":3000031566, "created_at":"2019-09-15T09:18:44.000Z", "updated_at":"2019-09-15T09:18:44.000Z", "user_id":3000053373, "start_date":"2019-01-01", "end_date":"2019-01-04", "status":"approved", "leave_units":3, "optional_leave_units":null, "leave_type_id":3000011436, "status_comments":null, "approved_by_id":null, "applied_by_id":3000053373, "cancelled_by_id":null, "rejected_by_id":null, "comments":"Going to out of station to visit doctor", "rejected_at":null, "cancelled_at":null }, {"id":3000031571, "created_at":"2019-09-15T09:18:44.000Z", "updated_at":"2019-09-15T09:18:44.000Z", "user_id":3000053373, "start_date":"2019-06-30", "end_date":"2019-07-10", "status":"approved", "leave_units":7, "optional_leave_units":null, "leave_type_id":3000011437, "status_comments":null, "approved_by_id":null, "applied_by_id":3000053373, "cancelled_by_id":null, "rejected_by_id":null, "comments":"On vacation with family", "rejected_at":null, "cancelled_at":null } ]
EXPAND ↓

Create a timeoff request

Creates a timeoff object based on the request body parameter. The request body parameter is a create timeoff object.

post
/api/time_offs
Sample request | Curl
Copied Copy
1
2
3
4
5
6
7
8
9
10
11
curl -X POST "https://<account-name>.freshteam.com/api/time_offs" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ" -H "Content-Type: application/json" -d '{ "start_date": "2019-11-15", "end_date": "2019-11-17", "optional_leave_days": [], "notify_to": [], "add_to_calendar": false, "auto_decline_events": false, "leave_type_id": 3000011437, "comments": "To attend a family function" }'
EXPAND ↓
Sample response

A successful request returns 201 Created along with the created timeoff object. The object contains the id, created_at, and updated_at attributes.

List all timeoff types

Retrieves a list of all vacation types configured for an organization.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

get
/api/time_off_types
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/time_off_types" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all vacation types, as an array. Each array entry is a timeoff type object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
[ {"id":3000011437, "created_at":"2019-09-15T09:18:43.000Z", "updated_at":"2019-11-16T05:17:52.000Z", "deleted":false, "name":"Earned", "description":"Earned Leave", "applicable_for":null, "default":true, "auto_approve":false, "auto_approve_after":null, "auto_approve_limit":null, "marital_status":null }, { "id":3000011436, "created_at":"2019-09-15T09:18:43.000Z", "updated_at":"2019-09-15T09:18:43.000Z", "deleted":false, "name":"Sick", "description":"Sick Leave", "applicable_for":null, "default":true, "auto_approve":false, "auto_approve_after":null, "auto_approve_limit":null, "marital_status":null } ]
EXPAND ↓

Roles

An employee’s access to different entities in the Freshteam system is based on the roles associated with the employee. Role permissions define the access privileges an employee is entitled to. Each role comes with a predefined set of privileges. For more information on roles, see Understanding user roles in Freshteam.

Endpoint

GET /roles

The role object

Example
1
2
3
4
5
6
7
8
{ "id":3000060409, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-11-09T06:00:07.000Z", "name":"Account Admin", "description":"Can Access \u0026 Modify the entire Freshteam account including account and billing related information.", "default":true }
EXPAND ↓
Attributes
Attribute Name Data Type Description
id number Identifier of a role object, auto-created when a role is created in the Freshteam system.
created_at string Timestamp of when the role is created, specified in the date-time format.
updated_at string Timestamp of when the role details are last updated, specified in the date-time format.
name string Descriptive identifier of the role. For example, Account Admin, Admin, HR Partner, and so on.
description string Details about the role, mentioning the different privileges provided to a user with the role permission.
default boolean Specifies whether a role is a default role in the Freshteam system or a custom role configured by the organization that uses Freshteam.
Possible values: true, false

List all roles

Retrieves a list of all valid roles for the organization that uses Freshteam.

Note: Only users in HR Partner, Admin, and Account Admin roles can access this API.

get
/api/roles
Sample request | Curl
Copied Copy
1
2
curl -X GET "https://<account-name>.freshteam.com/api/roles" -H "accept: application/json" -H "Authorization: Bearer D4HN6sD0qjUVI32cDCnQeQ"
EXPAND ↓
Sample response

A successful request returns 200 OK along with all roles’ details, as an array. Each array entry is a role object with the corresponding attributes. The response data is limited by the pagination parameters passed in the request. The response header contains the pagination details.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
[ { "id":3000060409, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-11-09T06:00:07.000Z", "name":"Account Admin", "description":"Can Access and Modify the entire Freshteam account including account and billing related information.", "default":true }, { "id":3000060410, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-11-09T06:00:07.000Z", "name":"Admin", "description":"Can Access and Modify all configurations in the Settings and will have complete access to all modules, but are restricted from Viewing Account and Billing settings.", "default":true }, { "id":3000060416, "created_at":"2019-09-15T09:17:43.000Z", "updated_at":"2019-11-09T06:00:07.000Z", "name":"Employee", "description":"Can View limited set of information of other Employees, Request timeoff, View company job postings and Refer a candidate to an Organisation.", "default":true } ]
EXPAND ↓