How can I display my open positions on my company's website?

You can display the published jobs from your Webbtree ATS on to the careers page of your website by using our REST API. Using the unique token for your company that you can find in the “Settings”>“Careers site” section in Webbtree ATS you can get all the jobs that are published. 

Getting the API token:

Go to the settings tab from the left navigation bar and select ‘careers site’

In this section, in the right side of the screen you can find the API token that your developers would require to get all the required jobs.

Clicking on these jobs, opens up the Webbtree candidate platform link to a specific job for the candidates to apply. Below is an example of one such careers site by a company that uses Webbtree ATS.

Here is how you can use the API:

Sample Request Body:

{

   "api_token": "<token from the Webbtree ATS>",

   "filters": {

       "jobnameordept":"Finance",

       "employmenttype":"Full Time",

       "locationname":"Mumbai"

   }

}

Request Parameters:

1. api_token: Mandatory parameter that must be passed with every API call

2. filters: Optional parameter containing details about the filters that need to be applied while fetching jobs

i. If filters object is not passed, by default all jobs would be returned without applying any  filter. Filters can be one or more of the following:

• jobnameordept: Corresponds to job name or department (Optional parameter)

• employmenttype: Corresponds to employment type (Optional parameter)

• locationname: Corresponds to location name (Optional  parameter)

API response:

Parameters received in API response: 

1. code: Corresponds to API status code. Values can be as follows:
   1. 200: When API is successfully executed
   2. 400: When certain parameters are missing in request body
   3. 401: When the api_token sent in request body is invalid
   4. 500: When there is some issue with the API
2. status: Corresponds to API status. Values can be either “success” or “failure”
3. jobs: Array of job objects. Length of the jobs array will be zero when there are no jobs in the database or no jobs match the filters specified in request parameters
4. message: Error message received in API response when API fails. Values can be:

   1. Missing parameters in request body (Received with 400 status code)

   2. Invalid token (Received with 401 status code)

   3. Internal Server Error (Received with 500 status code)

Sample response objects:

Scenario 1: When API is successfully executed and zero or more jobs are returned in response

{

   "code": 200,

   "status": "success",

   "jobs": [

       {

           "jobname": "Finance manager",

           "functions": "Finance",

           "locationname": "Mumbai,India",

           "employmenttype": "Fulltime",

           "jobnumber": "ada2dc",

           "jobdescriptionurl": "https://clientsubdomain.webbtree.com/candidate/career/jobdetail/ada2dc"

       },

       {

           "jobname": "Accountant",

           "functions": "Finance",

           "locationname": "Singapore,Singapore",

           "employmenttype": "Fulltime",

           "jobnumber": "ab30b4",

           "jobdescriptionurl": "https://clientsubdomain.webbtree.com/candidate/career/jobdetail/ab30b4"

       }

   ]

}

Note: jobdescriptionurl corresponds to the Webbtree ATS’s candidate platform URL for a job that needs to be opened for the candidate to view details of the job and apply to the job.

Scenario 2: When API token is not valid

{

   "code": 401,

   "status": "failure",

   "message": "Invalid token"

}

Scenario 3: When request parameters are missing

{

   "code": 400,

   "status": "failure",

   "message": "Missing parameters in request body"

}

Scenario 4: When there is some backend error during API processing

{

   "code": 500,

   "status": "failure",

   "message": "Internal Server Error"

}

Thus you can use these APIs to implement filters for this job listing on your website’s careers site as well.