Ceipal

&lt;p>&lt;span style="color:rgb(105,118,137);">Welcome to CEIPAL API. CEIPAL v1 API allows the customers to extract the data from their account to build any customized solutions as needed.&lt;/span>&lt;/p>&lt;br>&lt;p>&lt;span style="background-color:rgb(255,255,255);color:rgb(105,118,137);">Rate limiting of the API is based on user authentication token and this is applicable to all authenticated endpoints. Once the rate limit is reached all the endpoints would return 400 error code.&lt;/span>&lt;/p>&lt;br>&lt;p>&lt;span style="color:rgb(105,118,137);">All API requests must be made over HTTPS. Calls made over plain HTTP will fail.&lt;/span>&lt;/p>&lt;br>&lt;p>We have introduced new endpoints and made significant changes to the existing endpoints. Now all the endpoints are using the encrypted ids to enhance the data security. Please reach out to your CEIPAL account representative for more details as how to generate the API credentials to start using the endpoints.&lt;/p>&lt;br>

Ceipal ATS v2 API Reference

v1 to v2 Migration

&lt;p>&lt;span style="color:rgb(105,118,137);">CEIPAL API uses the combination of the User Name, Password and API Key to validate with the client's account to generate the Bearer Token. All the endpoints will be using this Bearer Token to access the data.&lt;/span>&lt;/p>&lt;br>&lt;p>&lt;span style="color:rgb(105,118,137);">Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys and it is advisable to rotate the API Key frequently for any misuse.&lt;/span>&lt;/p>&lt;br>&lt;p>&lt;span style="color:rgb(105,118,137);">All API requests must be made over HTTPS. Calls made over plain HTTP will fail.&lt;/span>&lt;/p>&lt;br>

Authentication

&lt;p>Authentication token is valid for 24 hours and to continue using the API, a new auth token needs to be generated. Use the refresh token to generate the new auth token and the refresh token is valid for 7 days.&lt;/p>&lt;br>&lt;p>Send the access token in the headers as Token to get the new access token.&lt;/p>&lt;br>

Refresh Token

&lt;p>This object represents a job on the client's account. Below are the endpoints that can be used to extract the jobs with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>&lt;figure class="notification-box-item primary-box ck-widget">&lt;div class="notification-box-header">&lt;p class="notification-title">Tip&lt;/p>&lt;/div>&lt;p class="notification-description">&lt;span style="color:rgb(186,104,200)!important;">&lt;code>Use the Custom API to get any other fields as the response this is shown here is standard. Check with your CEIPAL account manager for more details.&lt;/code>&lt;/span>&lt;/p>&lt;/figure>&lt;br>

Job Postings

&lt;p>Extract the single job with more details. Need to pass the auth token as the Bearer Token along with the job id in the query parameters. The response contains the standard fields.&lt;/p>&lt;br>&lt;figure class="notification-box-item primary-box ck-widget">&lt;div class="notification-box-header">&lt;p class="notification-title">Tip&lt;/p>&lt;/div>&lt;p class="notification-description">&lt;span style="color:rgb(186,104,200)!important;">&lt;code>Use the Custom API to get any other fields as the response this is shown here is standard. Check with your CEIPAL account manager for more details.&lt;/code>&lt;/span>&lt;/p>&lt;/figure>&lt;br>

Job Posting Details

Job Requisitions

Job Requisitions Details

&lt;p>This object represents an applicant on the client's account. Below are the filters that can be used to extract the applicants with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>&lt;figure class="notification-box-item primary-box ck-widget">&lt;div class="notification-box-header">&lt;p class="notification-title">Tip&lt;/p>&lt;/div>&lt;p class="notification-description">&lt;span style="color:rgb(186,104,200)!important;">&lt;code>Use the Custom API to get any other fields as the response this is shown here is standard. Check with your CEIPAL account manager for more details.&lt;/code>&lt;/span>&lt;/p>&lt;/figure>&lt;br>

Applicants

Applicant Details

&lt;p>This object represents a submission on the client's account. Below are the filters that can be used to extract the submissions with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>&lt;figure class="notification-box-item primary-box ck-widget">&lt;div class="notification-box-header">&lt;p class="notification-title">Tip&lt;/p>&lt;/div>&lt;p class="notification-description">&lt;span style="color:rgb(186,104,200)!important;">&lt;code>Use the Custom API to get any other fields as the response this is shown here is standard. Check with your CEIPAL account manager for more details.&lt;/code>&lt;/span>&lt;/p>&lt;/figure>&lt;br>

Submissions

&lt;p>Extract the complete submission information with more details. Need to pass the auth token as the Bearer Token along with the submission id in the query parameters. The response contains the standard fields.&lt;/p>&lt;br>&lt;p>Submission details response has the job seeker id and job id. If any further information is required, pass these values to the corresponding endpoints to get the corresponding data.&lt;/p>&lt;br>&lt;figure class="notification-box-item primary-box ck-widget">&lt;div class="notification-box-header">&lt;p class="notification-title">Tip&lt;/p>&lt;/div>&lt;p class="notification-description">&lt;span style="color:rgb(186,104,200)!important;">&lt;code>Use the Custom API to get any other fields as the response this is shown here is standard. Check with your CEIPAL account manager for more details.&lt;/code>&lt;/span>&lt;/p>&lt;/figure>&lt;br>

Submission Details

Talent Bench

Bench Details

&lt;p>This object represents the clients object on the client's account. Below are the filters that can be used to extract the clients with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>

Clients

&lt;p>This endpoint gives the complete client information along with the client contacts based on the client id that is passed as the parameter.&lt;/p>&lt;br>

Client Details

Client Notes List

Client Contacts

Leads

Leads Details

Vendors

Vendor Details

&lt;p>This object represents an interview object on the client's account. Below are the filters that can be used to extract the interviews with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>&lt;figure class="notification-box-item primary-box ck-widget">&lt;div class="notification-box-header">&lt;p class="notification-title">Tip&lt;/p>&lt;/div>&lt;p class="notification-description">&lt;span style="color:rgb(186,104,200)!important;">&lt;code>Use the Custom API to get any other fields as the response this is shown here is standard. Check with your CEIPAL account manager for more details.&lt;/code>&lt;/span>&lt;/p>&lt;/figure>&lt;br>

Interviews

&lt;p>This endpoint gives the complete interview details based on the interview id that is passed as the parameter.&lt;/p>&lt;br>

Interview Details

&lt;p>This object represents the placements on the client's account. Below are the filters that can be used to extract the placements with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>

Placements

Placement Details

&lt;p>This object represents the users on the client's account. Below are the filters that can be used to extract the users with various filters. Rate limit applies to these endpoints based on the API Key.&lt;/p>&lt;br>

Users

&lt;p>This endpoint gives the complete user details based on the user id that is passed as the parameter.&lt;/p>&lt;br>

User Details

&lt;p>Data from these endpoints are used across all the other endpoints as these contains the master data.&lt;/p>&lt;br>

Master Data

Job Types

Job Categories

&lt;p>This master data endpoint has the required information for the Applicant Profile Statuses.&lt;/p>&lt;br>

Applicant Status

&lt;p>This master data endpoint has the required information for the .&lt;/p>&lt;br>

Applicant Sources

Business Units

&lt;p>This master data endpoint has the required information for the  list.&lt;/p>&lt;br>

Countries

Client Categories

Client Statuses

&lt;p>This master data endpoint has the required information for the Applicant Clearance Type.&lt;/p>&lt;br>

Clearance Types

&lt;p>This master data endpoint has the required information for the Employment Type.&lt;/p>&lt;br>

Employment Types

Industries

&lt;p>This master data endpoint has the required information for the Job Statues list.&lt;/p>&lt;br>

Job Statuses

Pay Frequency Types

&lt;p>This master data endpoint has the required information for the Countries list.&lt;/p>&lt;br>

States List

Work Authorizations

CEIPAL V1

CEIPAL ATS V2

Production

SandBox

<p class="slate-p " ><p class="slate-p " >This endpoint retrieves the complete lead information, including lead ID provided as a parameter.</p><p class="slate-p " ></p></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><div class="slate-div"></div><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

Content-Type

Authorization

business_unit_id

name

country

state

city

zipcode

website

ownership

created_by

created_at

industry_type

lead_status

updated_at

updated_by

modified_by

contacts

created_on

modified_on

status

message

{
  "message": "Invalid parameters or filters."
}

{
  "message": "Please provide the access token."
}


{
  "message": "Your company access is temporarily disabled."
}

{
  "message": "Request limit exceeded. Please try again later."
}

This endpoint retrieves the complete lead information, including lead ID provided as a parameter.

Sections

Leads Details

Header Parameters

Response

Response Attributes

Response Attributes

What made this section helpful for you?

What made this section unhelpful for you?

Response

What made this section helpful for you?

What made this section unhelpful for you?