Data Methods

You can use data methods to retrieve information about different objects on a page.

loggedInUser

Returns details of a user who is logged into the Freshteam user interface.

Copied Copy 
1
2
3
4
5
6
7
8
client.data.get("loggedInUser").then (
    function(data) {
      // success output
      },
    function(error) {
      // failure operation
      }
    );

Sample Output Payload

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": "34324",
      "name": "Joe Michael",
      "first_name": "Joe",
      "middle_name": ,
      "last_name": "Michael",
      "role_ids": [1,23],
      "timezone": "en/us",
      "designation": "Manager",
      "branch": {
        "id": 1,
        "name": "Chennai Branch",
        "city": "Chennai",
        "street": "",
        "state": "TN",
        "country_code": "IN",
        "main_offfice": true,
        "deleted": false,
        "date_format": "MM/DD/YYYY",
        "time_zone": "Asia"
        },
      "user_type": "full_time",
      "language": "en",
      "joining_date": "2020-02-02",
      "email": "joe.michael@xyz.com"
    }
EXPAND ↓

Attributes of the loggedInUser object

Attribute Date Type Description
id string Identifier of the logged in user.
name string Name of the user.
first_name string Business name of the user.
middle_name string Middle name of the user.
last_name string Last name of the user.
role_ids array of numbers Identifiers of the roles associated with the user who is logged in. When a role is configured in Freshteam, an auto-generated identifier is associated with the role.
timezone string Time-zone applicable to the branch to which the user is associated.
designation string Job title of the user.
branch branch object Details of the branch to which the user is associated.
user_type string Employment terms associated with the user.
For example,
Full Time, Part Time, Contract, Internship, Temporary, Seasonal, Volunteer, Fixed Term Contract, Secondment, and so on.
language string Primary language of the branch to which the user is associated.
joining_date string Date, in the UTC format, specified as the user’s joining date.
email string Email address of the user.

Attributes of the branch object

Attribute Date Type Description
id number Identifier of the branch object. This value is auto-generated.
name string Descriptive identifier of the branch.
city string City in which the branch is located.
street string Address parameter of the branch.
state string Province in which the branch is located.
country_code string Country in which the branch is located, specified as a character code.
main_offfice boolean Specifies whether the branch is the main office at a location.
Possible values: true, false
deleted boolean Specifies whether the branch is still a valid location. For deleted branches, the attribute is set as true.
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)
time_zone string Time-zone applicable to the branch location.
domainName

Returns the domain name of the business account that uses Freshteam.

Copied Copy 
1
2
3
4
5
6
7
8
client.data.get("domainName").then (
    function(data) {
      //Success operation
    },
    function(error) {
      // failure operation
    }
    );

Sample Output Payload

1
"name": "domain.freshteam.com"

Data Returned by the domainName object

Date Type Description
string Domain name assigned by Freshteam, for a business account.
jobPosting

Returns details of the job posting in the Job Posting Details page.

Copied Copy 
1
2
3
4
5
6
7
8
client.data.get("jobPosting").then (
    function(data) {
      // success output
    },
    function(error) {
      // failure operation
    }
    );

Sample Payload

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
{
  "id": "753839",
  "title": "Sample Job Posting",
  "description": "Sample Job",
  "deleted": false,
  "remote": false,
  "experience": "Entry Level",
  "status": "Published",
  "show_pursue_as_career": false,
  "applicant_apply_link": "https://test.freshteam.com/jobs/iITkQ-SkR09k",
  "applicant_access_type":  "open",
  "type": "contract",
  "branch": {
    "id": 1,
    "name": "Chennai Branch",
    "city": "Chennai",
    "street": "",
    "state": "TN",
    "country_code": "IN",
    "main_offfice": true,
    "deleted": false,
    "date_format": "MM/DD/YYYY",
    "time_zone": "Asia"
      },
  "department": {
    "id": 1,
    "name": "Sales",
    "deleted": false
      },
  "skills": ["SALES", "MARKETING"],
  "salary":  {
      "min": 1000,
      "max": 2000,
      "currency": "USD"
      },
  "custom_field_values": {
      "custom_1": "fewf",
      "custom_2": "3232"
      },
  "created_at": "2020-06-10T04:27:55.000Z",
  "updated_at": "2020-06-10T08:27:55.000Z"
}
EXPAND ↓

Attributes of the jobPosting object

Attribute Date Type Description
id string Identifier of a job posting, auto-generated when a job posting is created in the Freshteam system.
title string Descriptive identifier of the job posting. For example, Marketing, Administration, Finance and so on.
description srting Details about the job posting.
deleted boolean Specifies whether the posting exists in the Freshteam system.
Possible values: true, false
remote boolean Specifies whether the job posting is open for remote work.
Possible values: true, false
experience string Experience level associated with the job role. For example, Internship, Entry level, Associate, Mid-senior level, Director/Vice-President, Executive/President, and so on.
status string Status of the job posting. For example, Active, Draft, Published, On Hold, Closed, Deleted, and so on.
show_pursue_as_career boolean Specifies whether the job posting is enabled for internal applicants as well.
Possible values: true, false
applicant_apply_link string URL using which candidates can apply to the job posting.
applicant_access_type string Type of access granted to users to view applicant information.
type string Employment terms associated with the job posting.
Possible values:
Full Time, Part Time, Contract, Internship, Temporary, Seasonal, Volunteer, Fixed Term Contract, Secondment
branch branch object Branch where the job posting is open for recruitment.
department object Details of the department associated with the job posting.
Attributes of the department object:
id (number): Identifier of the department object, auto-generated when a new department is created in the Freshteam system.
name (string): Descriptive identifier of the department.
deleted (boolean): Specifies whether the department still exists in the organization.
Possible values: true, false
skills array of strings Skills associated with the job posting.
salary object Details of the salary band associated with the job posting.
Attributes of the salary object:
min (integer): Minimum salary associated with the job.
max (integer): Maximum salary associated with the job.
max (integer): Currency applicable to the min and max values.
custom_field_values object The organization that uses Freshteam can configure custom fields to specify additional information about the job posting. The custom_field_values 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.
created_at string Timestamp of when the job posting is created, specified in the UTC format.
updated_at string Timestamp of when the job posting is updated, specified in the UTC format.
applicant

Returns the details of an applicant for a job posting in the Recruit > Jobs > Details page > View Candidates page.

Copied Copy 
1
2
3
4
5
6
7
8
client.data.get("applicant").then (
  function(data) {
    // success operation
    },
  function(error) {
    // failure operation
    }
  );

Sample Payload

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
{
   "id":"1",
   "created_at":"2021-03-25T12:32:34.000Z",
   "updated_at":"2021-03-25T12:32:34.000Z",
   "status":"open",
   "deleted": false, 
   "sub_stage_id":"1",
   "on_hold_at":"",
   "on_hold_till":"2021-03-25T12:32:34.000Z",
   "rejected_at":null,
   "archived_at":null,
   "moved_at":null,
   "job_id":"4",
   "job_title":"Developer",
   "requisition_id":"3",
   "custom_fields": { "field_1": true, "field_2" : "" },
   "stage":{
      "id":"1",
      "name":"Open"
    },
   "candidate":{
      "id":"5",
      "first_name":"Jane",
      "last_name":"Smith",
      "middle_name":"Margaret",
      "email":"jane@domain.com",
      "mobile":"9999999999",
      "phone":"9999999999",
      "date_of_birth":"1990-03-25T12:32:34.000Z",
      "gender":"Female",
      "owner_id":"1",
      "skype_id":"",
      "source_id":"1",
      "source_category":"Direct",
      "deleted": false,
      "Spam": false,
      "total_experience_in_months": 12,
      "description":"Candidate experienced in people management",
      "Cool_off_date": null,
      "created_at":"2021-03-25T12:32:34.000Z",
      "updated_at":"2021-03-25T12:32:34.000Z",
      "tags":["agile development"],
      "skills":["Java"],
      "profile_links":{
         "url":"linkedin",
         "name":"http://www.linkedin.com/jane-smith"
      },
      "location": "Florida, US, 32003",
      "resumes": [{
         "id":"50",
         "content_file_name":"Jane-resume.pdf",
         "content_file_size":"9000",
         "description":"resume",
         "url":"http://freshteam.com/files/1"
      }]
   }}
EXPAND ↓

Attributes of the applicant object

Attribute Date Type Description
id string Identifier of the applicant object, auto-generated when a candidate is added as an applicant to a specific job posting.
created_at string Timestamp of when the candidate is added as an applicant to a job posting, specified in the UTC format.
updated_at srting Timestamp of when the applicant detail is last updated, specified in the UTC format.
status string Status of the application.
Possible values:
open: The application is under processing and is considered for the job posting for which the application is received.
on_hold: The application is on-hold for a specified time period.
rejected: The application is deleted from the candidate pool corresponding to the job opening.
archived: The application is archived in the talent pool.
moved: The application is moved to another suitable job opening in the Freshteam system.
dropped: The application is blocked and all future applications from the applicant will be rejected.
deleted boolean Specifies whether the applicant detail is deleted from the Freshteam system.
Possible values: true, false
sub_stage_id number Identifier of the subdivision of the hiring stage of the applicant, auto-generated when a customized hiring stage is configured in the Freshteam system.
on_hold_at string Timestamp of when the application is moved to an on-hold status, specified in the UTC format.
on_hold_till string Date and time till when the application is marked to be on-hold,specified in the UTC format.
rejected_at string Timestamp of when the application is moved to a rejected status, specified in the UTC format.
archived_at string Timestamp of when the application is moved to an archived status, specified in the UTC format.
moved_at string Timestamp of when the application is moved from its previous state to the current state, specified in the UTC format.
job_id string Identifier of the job posting object that corresponds to the job opening for which the applicant is added to the candidate pool.
job_title string Descriptive identifier of the job posting for which the applicant is added to the candidate pool.
requisition_id number Identifier of the job requisition object that specifies the details of job requisitions associated with the job opening.
custom_fields object Additional information about the applicant, specified through preconfigured custom fields. The custom_fields 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.
stage stage object Details of the hiring stage of the applicant.
candidate candidate object Additional information about the applicant.

Attributes of the stage object

Attribute Date Type Description
id string Identifier of the hiring stage of the applicant, auto-generated when a stage is configured in the Freshteam system.
name string Descriptive identifier of the hiring stage of the applicant.
For example, open, offer draft, offered, offer accepted, offer declined, hired and so on are the default stages.
candidate

Returns the details of a candidate added to the talent pool of the Freshteam system.

Copied Copy 
1
2
3
4
5
6
7
8
client.data.get("candidate").then (
  function(data) {
    // success operation
    },
  function(error) {
    // failure operation
    }
);

Sample Payload

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":"5",
    "first_name":"Jane",
    "last_name":"Smith",
    "middle_name":"Margaret",
    "email":"jane@domain.com",
    "mobile":"9999999999",
    "phone":"9999999999",
    "date_of_birth":"1990-03-25T12:32:34.000Z",
    "gender":"Female",
    "owner_id":"1",
    "skype_id":"",
    "source_id":"1",
    "source_category":"Direct",
    "deleted": false,
    "spam": false,
    "total_experience_in_months": 12,
    "description":"Candidate experienced in people management",
    "cool_off_date": "",
    "created_at":"2021-03-25T12:32:34.000Z",
    "updated_at":"2021-03-25T12:32:34.000Z",
    "tags":["agile development"],
    "skills":["Java"],
    "profile_links":{
        "url":"linkedin",
        "name":"http://www.linkedin.com/jane-smith"
            },
    "location": "Florida, US, 32003",
    "qualifications": [{
        "school_name": "XYZ university",
        "field_of_study": "Software engineering",
        "degree": "Bachelor of engineering",
        "summary": "",
        "grade": "4",
        "start_date": "2014-03-25T12:32:34.000Z",
        "end_date": "2018-03-25T12:32:34.000Z",
        "is_current": false
            }],
    "positions": [{
        "company": "ABC tech",
        "title": "developer",
        "summary": "",
        "start_date": "2019-03-25T12:32:34.000Z",
        "end_date": "2020-03-25T12:32:34.000Z",
        "is_current": false
            }],
    "resumes": [{
        "id":"50",
        "content_file_name":"Jane-resume.pdf",
        "content_file_size":"9000",
        "description":"resume",
        "url":"http://freshteam.com/files/163"
            }],
    "cover_letters":  [{
        "id":"51",
        "content_file_name":"Jane-cover-letter.pdf",
        "content_file_size":"9000",
        "description":"cover_letter",
        "url":"http://freshteam.com/files/164"
            }],
    "portfolios":  [{
        "id":"52",
        "content_file_name":"Jane-resume.pdf",
        "content_file_size":"9000",
        "description":"portfolio",
        "url":"http://freshteam.com/files/165"
            }]
    }
EXPAND ↓

Attributes of the candidate object

Attribute Date Type Description
id string Identifier of the candidate object, auto-generated when a candidate is added into the talent pool of the Freshteam system.
created_at string Timestamp of when the candidate is added to the Freshteam system, specified in the UTC format.
updated_at srting Timestamp of when the candidate detail is last updated, specified in the UTC format.
first_name string Name of the candidate.
last_name string Last name of the candidate.
middle_name string Middle name of the candidate.
email string Email address of the candidate.
mobile string Mobile contact number of the candidate.
phone string Telephone contact number of the candidate.
date_of_birth string Birth date of the candidate.
gender string Gender of the candidate.
owner_id string Identifier of the employee who is assigned as an owner for the job requisition. This is a valid employee.id value.
skype_id string Official skype address of the candidate.
source_id string Identifier of the source through which the candidate information reaches the Freshteam system.
source_category string Descriptive identifier of the source category to which the source identified by source_id belongs.
deleted boolean Specifies whether the candidate details are deleted from the Freshteam system.
Possible values: true, false
spam boolean Specifies whether the candidate details in the Freshteam system is spam.
Possible values: true, false
total_experience_in_months number Work experience of the candidate.
description string Summary of the candidate profile.
cool_off_date string Date till when the candidate cannot be added as an applicant to a job opening.
tags array of strings Descriptive key words added to the candidate’s profile.
skills array of strings All skills specified for the candidate.
profile_links object Details of the social platforms where the candidate’s work is displayed.
For example, Git, Dribble, Pinterest, and so on.
Attributes of the object:
url (string): Link to the applicant's social medium handle.
name (string): Name of the social medium.
location string Postal address of the candidate.
qualifications array of objects

Details of the educational qualifications of the candidate.

Attributes of the object:
school_name (string): Name of the institution the candidate has qualified from.
field_of_study (string): Name of the course pursued by the candidate to obtain a qualification.
degree (string): Qualification awarded to the candidate after completion of the course.
summary (string): Description of the course.
grade (string): Average score obtained by the candidate.
start_date (string): Date of initialization of the course.
end_date (string): Date of completion of the course.
is_current (boolean): Specifies whether the candidate is currently pursuing the course.
positions array of job position object

Details of the job positions held by the candidate previously.

Attributes of the job position object:
company (string): Name of the company, the candidate was previously employed in.
title (string): Descriptive name of the job position.
summary (string): Descriptive detail of the job position.
start_date (string): Date of initialization of employment.
end_date (string): Date of completion of the employment.
is_current (boolean): Specifies whether the candidate is currently an employee of the company.
resumes array of content file object Resumes of the applicant.
cover_letters array of content file object Cover letters attached to the application.
portfolios array of content file object Content such as work samples that supplement the resumes and cover letters.

Attributes of the content file object

Attribute Date Type Description
id string Identifier of the file uploaded as part of a job application.
content_file_name string Name of the file attached to the job application.
content_file_size string Size of the file.
description string Summary of the file contents.
url string Link to access the file.