We provide two options to integrate our published jobs into your website. Read more on How to display published jobs on your website

One of the option is to build your own career page using our APIs. Our API integration allows you to add published roles anywhere on your website.

Roles are fetched via the Application Programming Interface (API) including their descriptions, related metadata, and the apply link.

Steps:

Step 1: Build

Build a career page on your website after aligning internally on the content and the design.

Here are some tips on building great career pages

Step 2: Fetch job information and place it on your career page

Fetch roles from ATS and add them to your website

1. Get the company ID from Settings > Company > Brand & Career page.

   1. Access URL https://app.whitecarrot.io/#/recruiter-settings/brands

      

2. Use the APIs to get a list of the roles on your career site.

   <aside> 👉 Click here to access our API documentation

   </aside>

   1. API Overview
      • The API is available via encrypted HTTPS only.
      • The API does not require authentication and returns responses in JSON format.
      • Detailed information on requests, responses, and error codes is available in the API documentation.
      • List APIs (ex: List Roles API) support Pagination. Pagination usage is explained in the Examples Section below.
   2. Interactive API Documentation
      • You can test the APIs directly on the API documentation page using your Company ID.
   3. API Capabilities

      • Paginated Job Listings: Retrieve a list of job roles for your company.

        You can use List Roles API to get published roles and build your website. List Roles API supports pagination.

        1. Pagination parameters:
           1. page: Page parameter specifies which set of results to retrieve from the service. It starts with 1.
           2. take: This defines the page size. Number of items to be returned from the service. Max allowed is 100.
        2. Pagination in action:
           1. If page=1, take=50 then, our service returns items from 1 to 50 items.
           2. If page=2, take=50 then, our service returns items from 51 to 100 items.

      • Filtered Job Listings: Get job roles that match specific queries (e.g., published roles, internal job postings, talent pool roles).

      • Individual Job Roles: Retrieve details of a specific job role if you know the Job Role ID.

   4. API Limitations
      • Applicants must be redirected to our website using the job role link to complete their applications.
      • The requests are rate-limited, we allow 100 requests per minute.
   5. If you are concerned about any features, please contact us.

Examples:

1. Add External Published roles to your website
   1. Fetch roles: GET https://app.whitecarrot.io/api/partners/company/{{companyId}}/roles?page=1&take=20&status=PUBLISHED&roleType=EXTERNAL
   2. Show the roles returned in the above API on Your website.
   3. When a candidate clicks on Apply for a specific role, Redirect the user to the job role link which is sent in response.
2. Add a talent pool card for Collecting interested candidates on the Talent Pool.
   1. Fetch the talent Pool Job: GET https://app.whitecarrot.io/api/partners/company/671f4df0-3687-4da1-8714-905bb2a867e8/roles?page=1&take=20&status=PUBLISHED&roleType=TALENT_POOL
   2. Show the roles returned in the above API on Your Talent Pool website.
   3. When a candidate clicks on Apply for a specific role, Redirect the user to the job role link which is sent in response.

Step 3: Customize and show the apply button

• Make the roles list look like they're part of your site with custom styling.
• Add a button in the job card for the candidates to apply

Sample user interface for jobs section on your career page:

Sample UI 1: Job Postings with Job Card

https://codepen.io/TilakWC/pen/rNgMBwK