CEIPAL ATS V1

## Sections
• [Ceipal ATS v1 API Reference](https://developer.ceipal.com/ceipal-ats-version-one/ceipal-ats-v1-api-reference.md): CEIPAL ATS API V2 is now available . We recommend using the latest V2 APIs for enhanced integrations, webhook support, and improved performance. Explore CEIPAL ATS API V2 Documentation → Welcome to the CEIPAL ATS v1 API documentation. The CEIPAL v1 API empowers customers to seamlessly access and extract data from their CEIPAL account. It is designed to support the development of customized solutions that align with your unique business needs. With this API, you can integrate CEIPAL ATS with your internal tools, automate workflows, and gain deeper insights through custom reporting and dashboards. This documentation provides comprehensive guidance on all available endpoints, including authentication, data formats, request/response structures, and usage examples. Whether you're building a simple integration or a complex application, our API makes it easy to connect with CEIPAL ATS securely and efficiently. Rate limiting of the API is based on the user authentication token and applies to all authenticated endpoints. Once the rate limit is reached, all endpoints will return a 429 Too Many Requests error. 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 ones. All endpoints now use encrypted IDs to enhance data security. Please contact your CEIPAL account representative for information on generating API credentials and getting started with the updated endpoints.
• [Authentication](https://developer.ceipal.com/ceipal-ats-version-one/authentication.md): CEIPAL API uses a combination of Username, Password, and API Key to authenticate and generate a Bearer Token. This Bearer Token is required to access all API endpoints. Your API keys carry significant privileges, so it is important to keep them secure. Do not share your secret API keys. CEIPAL provides an option to rotate your API credentials, which involves updating the API password. It is recommended to perform this rotation regularly to maintain security and prevent unauthorized access. access_token valid for 1 hour refresh_token valid for 7 days All API requests must be made over HTTPS. Calls made over plain HTTP will fail.
• [Refresh Token](https://developer.ceipal.com/ceipal-ats-version-one/refresh-token.md): The authentication token is valid for 1 hour. To continue using the API after it expires, you must generate a new access token using the refresh token. The refresh token remains valid for 7 days. To obtain a new access token, include the expired access token in the request headers as Token .
• [Job Postings](https://developer.ceipal.com/ceipal-ats-version-one/job-postings.md): This object represents a job within the client's account. The following endpoints can be used to retrieve job postings with various filters. Rate limit applies to these endpoints.. Tip: 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.
• [Job Posting Details](https://developer.ceipal.com/ceipal-ats-version-one/job-posting-details.md): 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: 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.
• [Applicants](https://developer.ceipal.com/ceipal-ats-version-one/applicants.md): 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. 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.
• [Applicant Details](https://developer.ceipal.com/ceipal-ats-version-one/applicant-details.md): 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: 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.
• [Submissions](https://developer.ceipal.com/ceipal-ats-version-one/submissions.md): 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. Tip: 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.
• [Submission Details](https://developer.ceipal.com/ceipal-ats-version-one/submission-details.md): 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: 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.
• [Talent Bench](https://developer.ceipal.com/ceipal-ats-version-one/talent-bench.md): 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 .
• [Bench Details](https://developer.ceipal.com/ceipal-ats-version-one/bench-details.md): 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.
• [Clients](https://developer.ceipal.com/ceipal-ats-version-one/clients.md): 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. 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.
• [Client Details](https://developer.ceipal.com/ceipal-ats-version-one/client-details.md): This endpoint gives the complete client information along with the client contacts based on the client id that is passed as the parameter.
• [Leads](https://developer.ceipal.com/ceipal-ats-version-one/clients-copy-1.md): 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. 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.
• [Leads Details](https://developer.ceipal.com/ceipal-ats-version-one/client-details-copy-1.md): This endpoint gives the complete client information along with the client contacts based on the client id that is passed as the parameter.
• [Vendors](https://developer.ceipal.com/ceipal-ats-version-one/leads-copy-1.md): 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. 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.
• [Vendor Details](https://developer.ceipal.com/ceipal-ats-version-one/leads-details-copy-1.md): This endpoint gives the complete client information along with the client contacts based on the client id that is passed as the parameter.
• [Interviews](https://developer.ceipal.com/ceipal-ats-version-one/interviews.md): 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. Tip: 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.
• [Interview Details](https://developer.ceipal.com/ceipal-ats-version-one/interview-details.md): This endpoint gives the complete interview details based on the interview id that is passed as the parameter.
• [Placements](https://developer.ceipal.com/ceipal-ats-version-one/placements.md): 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. 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.
• [Placement Details](https://developer.ceipal.com/ceipal-ats-version-one/placement-details.md): This endpoint gives the complete interview details based on the interview id that is passed as the parameter.
• [Users](https://developer.ceipal.com/ceipal-ats-version-one/users.md): 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.
• [User Details](https://developer.ceipal.com/ceipal-ats-version-one/user-details.md): This endpoint gives the complete user details based on the user id that is passed as the parameter.
• [Master Data](https://developer.ceipal.com/ceipal-ats-version-one/master-data.md): Data from these endpoints are used across all the other endpoints as these contains the master data.
  • [Job Types](https://developer.ceipal.com/ceipal-ats-version-one/master-data/job-categories-copy-1.md): This master data endpoint has the required information for the .
  • [Job Categories](https://developer.ceipal.com/ceipal-ats-version-one/master-data/work-authorizations-copy-1.md): This master data endpoint has the required information for the .
  • [Applicant Status](https://developer.ceipal.com/ceipal-ats-version-one/master-data/applicant-status.md): This master data endpoint has the required information for the Applicant Profile Statuses.
  • [Applicant Sources](https://developer.ceipal.com/ceipal-ats-version-one/master-data/applicant-sources.md): This master data endpoint has the required information for the .
  • [Business Units](https://developer.ceipal.com/ceipal-ats-version-one/master-data/business-units.md): This master data endpoint has the required information for the .
  • [Countries](https://developer.ceipal.com/ceipal-ats-version-one/master-data/countries.md): This master data endpoint has the required information for the list.
  • [Client Categories](https://developer.ceipal.com/ceipal-ats-version-one/master-data/client-categories.md): This master data endpoint has the required information for the .
  • [Client Statuses](https://developer.ceipal.com/ceipal-ats-version-one/master-data/client-statuses.md): This master data endpoint has the required information for the .
  • [Clearance Types](https://developer.ceipal.com/ceipal-ats-version-one/master-data/clearance-types.md): This master data endpoint has the required information for the Applicant Clearance Type.
  • [Employment Types](https://developer.ceipal.com/ceipal-ats-version-one/master-data/employment-types.md): This master data endpoint has the required information for the Employment Type.
  • [Industries](https://developer.ceipal.com/ceipal-ats-version-one/master-data/industries.md): This master data endpoint has the required information for the .
  • [Job Statuses](https://developer.ceipal.com/ceipal-ats-version-one/master-data/job-statuses.md): This master data endpoint has the required information for the Job Statues list.
  • [Pay Frequency Types](https://developer.ceipal.com/ceipal-ats-version-one/master-data/pay-frequency-types.md): This master data endpoint has the required information for the .
  • [States List](https://developer.ceipal.com/ceipal-ats-version-one/master-data/states-list.md): This master data endpoint has the required information for the Countries list.
  • [Work Authorizations](https://developer.ceipal.com/ceipal-ats-version-one/master-data/work-authorizations.md): This master data endpoint has the required information for the .
• [Apply Without Registration](https://developer.ceipal.com/ceipal-ats-version-one/apply-without-registration.md): The "Apply Without Registration" section allows users to submit job applications without the need to register for an account. By providing essential personal and contact information, users can apply for a job directly through this API endpoint. This feature streamlines the application process and enhances user experience by eliminating the registration barrier. Go to admin setup click on applicants> custom api configuration
• [Create Applicant](https://developer.ceipal.com/ceipal-ats-version-one/apply-without-registration-copy-1.md): The Create Applicant API endpoint allows users to submit job applications without the need for account registration . By providing essential details such as personal and contact information, applicants can easily apply through this streamlined and user-friendly interface . Go to admin setup click on applicants> custom api configuration