Ceipal

Welcome to CEIPAL API. CEIPAL v1 API allows the customers to extract the data from their account to build any customized solutions as needed. 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. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. 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.

CEIPAL v1 API Reference

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. 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. All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Authentication

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. Send the access token in the headers as Token to get the new access token.

Refresh Token

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. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Job Postings

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. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Job Posting Details

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. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Applicants

Extract the complete applicant details with more details. Need to pass the auth token as the Bearer Token along with the applicant id in the query parameters. The response contains the standard fields. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Applicant Details

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.

Clients

This endpoint gives the complete client information along with the client contacts based on the client id that is passed as the parameter.

Client Details

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. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Submissions

Apply Without Registration

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. 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. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Submission Details

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. <figure class="notification-box-item primary-box ck-widget"><div class="notification-box-header">Tip</div><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.</code></figure>

Interviews

This endpoint gives the complete interview details based on the interview id that is passed as the parameter.

Interview Details

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.

Placements

Placement Details

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.

Users

This endpoint gives the complete user details based on the user id that is passed as the parameter.

User Details

Data from these endpoints are used across all the other endpoints as these contains the master data.

Master Data

This master data endpoint has the required information for the Applicant Profile Statuses.

Applicant Status

This master data endpoint has the required information for the .

Applicant Sources

Business Units

This master data endpoint has the required information for the list.

Countries

Client Categories

Client Statuses

This master data endpoint has the required information for the Applicant Clearance Type.

Clearance Types

This master data endpoint has the required information for the Employment Type.

Employment Types

Industries

This master data endpoint has the required information for the Job Statues list.

Job Statuses

Pay Frequency Types

This master data endpoint has the required information for the Countries list.

States List

Work Authorizations

CEIPAL V1

Welcome to CEIPAL API. CEIPAL v1 API allows the customers to extract the data from their account to build any customized solutions as needed.
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.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
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.

CEIPAL API uses the combination of the User Name, Password and API Key to validate with the client&apos;s account to generate the Bearer Token. All the endpoints will be using this Bearer Token to access the data.
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.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail.

Email address that has administrator access to the ATS product

email

Password that is configured in the ATS Admin Panel to use the API

password

API Key that is configured in the ATS Admin Panel to use this API.

api_key

Content-Type

access_token

refresh_token

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.
Send the access token in the headers as Token to get the new access token.

Token

Send the expired authentication token as the bearer token to get the new authentication token.

This object represents a job on the client&apos;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.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

Authorization

Get the auth token from the authentication endpoint and pass it as the bearer token

bearer token

Default page limit is 20 and can go up to 50 records per page.

limit

Every job is associated with a business unit. Pass the business unit id as the parameter to get the jobs.

business_unit_id

Pull the jobs based on the country. Use the countries endpoint to get the list of countries.

country

Pass the state id as the parameter to get the jobs. Use the states endpoint to get the states list.

state

Use the job status endpoint from the master data to get the job statuses. Pass the id here to pull the matching jobs.

job_status

Send 1 to get all the jobs that are posted on the careers page.0 for the jobs that are not posted.

post_on_careerportal

To get the jobs in between the dates, use this parameter

fromdate

This parameter works along with the fromdate. Gives the jobs that are created between the from date and to date.

todate

When the from date and to dates are used, this parameter is mandatory. Use ‘created’ as the filter value to get the jobs that are created between the from and to dates.

filter

Pass any numeric value to get the jobs that are created within this number of days.

posted_ago_days

Use either asc or desc to sort the job postings list.

sortorder

This filter is used along with the sortorder. Job postings can be sorted based on the job code, created date, modified date.

sortby

Pass the assigned recruiter id from the users endpoint to pull the jobs that are assigned to that recruiter.

assigned_recruiter

detail

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.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

Pass the id value from the job posting list endpoint to get the job details.

job_id

job_code

position_title

address

city

postal_code

created

posted_by

duration

experience

min_experience

job_start_date

job_end_date

modified

work_authorization

number_of_positions

closing_date

remote_opportunities

requisition_description

public_job_desc

public_job_title

employment_type

pay_rates

primary_recruiter

department

currency

industry

tax_terms

skills

apply_job

apply_job_without_registration

contact_person

posted

status

message

This object represents an applicant on the client&apos;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.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

Pass the created by user id from the users endpoint to pull the applicants that are created by that user.

created_by

Use this filter to get the applicants that are created from a specific source. Get the source id from the source endpoint.

source

Use this filter to get the applicants that are under a specific applicant status. Get the applicant status id from the applicant status endpoint.

applicant_status

Use either asc or desc to sort the applicants list.

This filter is used along with the sortorder. Applicants can be sorted based applicant id.

applicant_id

firstname

lastname

middlename

consultant_name

email_address_1

other_phone

mobile_number

created_at

resume_path

home_phone_number

work_phone_number

job_title

Extract the complete applicant details with more details. Need to pass the auth token as the Bearer Token along with the applicant id in the query parameters. The response contains the standard fields.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

Pass the id value from the applicants list endpoint to get the applicant details.

Pass the applicant_id value from the applicants list endpoint to get the applicant details.

This object represents the clients object on the client&apos;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.

This endpoint gives the complete client information along with the client contacts based on the client id that is passed as the parameter.

name

ownership

website

primary_business_unit

accessible_business_units

contacts

industry_type

accounts

This object represents a submission on the client&apos;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.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

Send the encrypted job id as a parameter to get all the submissions happened to that job.

Send the encrypted applicant id as a parameter to get all the submissions happened to that applicant.

job_seeker_id

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.
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.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

Pass the id value from the submissions list endpoint to get the submission details.

submission_id

tax_term

resume

Documents

submitted_on

submission_status

This object represents an interview object on the client&apos;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.
Tip<code style="color:rgb(186, 104, 200)" class="slate-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.</code>

This endpoint gives the complete interview details based on the interview id that is passed as the parameter.

Pass the id value from the interviews list endpoint to get the complete interview details.