CEIPAL

## Sections
• [API Reference](https://developer.ceipal.com/ceipalats/api-reference.md): Welcome to CEIPAL API. CEIPAL API allows the customers to extract the data from their account to build any customized solutions as per 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.
  • [V1](https://developer.ceipal.com/ceipalats/api-reference/v1.md): For the version ..
• [Authentication](https://developer.ceipal.com/ceipalats/authentication.md): 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.
• [Refresh Token](https://developer.ceipal.com/ceipalats/refresh-token.md): 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.
• [Common Elements](https://developer.ceipal.com/ceipalats/common-elements.md): Common elements are used by all the endpoints to access the data. This is considered as the master data and the data varies based on the client's configuration.
  • [Countries](https://developer.ceipal.com/ceipalats/common-elements/countries.md): This endpoint gives all the configured on the client's account matching with the API Key.
  • [States](https://developer.ceipal.com/ceipalats/common-elements/states.md): This endpoint gives all the configured on the client's account matching with the API Key.
  • [Industries](https://developer.ceipal.com/ceipalats/common-elements/industries.md): This endpoint gives all the configured on the client's account matching with the API Key.
  • [Job Statuses](https://developer.ceipal.com/ceipalats/common-elements/job-statuses.md): This endpoint gives all the Job Postings statuses that are configured on the client's account matching with the API Key.
  • [Job Type](https://developer.ceipal.com/ceipalats/common-elements/job-type.md): This endpoint gives all the s that are configured on the client's account matching with the API Key.
• [Pagination](https://developer.ceipal.com/ceipalats/pagination.md): Since the clients will have huge data set, CEIPAL API pulls the data in chunks to load the data faster. Through the pagination, clients can request more data as it is not a feasible approach to extract all the data with a single API request. Use the parameter shown as below to extract the records from. the specific API.
• [Job Postings](https://developer.ceipal.com/ceipalats/job-postings.md): 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.
  • [Get Jobs](https://developer.ceipal.com/ceipalats/job-postings/get-jobs.md): Retrieves the jobs for the given auth token. Need to pass the auth token as the Bearer Token to get the jobs listing.
  • [Job Posting Filters](https://developer.ceipal.com/ceipalats/job-postings/job-posting-filters.md): Jobs can be extracted with various filters and below are the list of filters that can be used for now. Bearer token is mandatory along with one of the filters to get the data. Only one filter should be used and combination won't work except for some of the filters.
  • [Get Job By ID](https://developer.ceipal.com/ceipalats/job-postings/get-job-by-id.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 URL. The response contains the standard fields and also the custom fields that are created by the clients.
  • [Jobs By Dates](https://developer.ceipal.com/ceipalats/job-postings/jobs-by-dates.md): Clients can pull the jobs that are created between certain dates. Use the below parameters to the endpoint to get the job postings.
• [Applicants](https://developer.ceipal.com/ceipalats/applicants.md): This object represents an applicant on the client's account. Below are the endpoints that can be used to extract the applicants with various filters. Rate limit applies to these endpoints based on the API Key.
  • [Get Applicants](https://developer.ceipal.com/ceipalats/applicants/get-applicants.md): Retrieves the applicants for the given auth token. Need to pass the auth token as the Bearer Token to get the jobs listing.
  • [Get Applicant By ID](https://developer.ceipal.com/ceipalats/applicants/get-applicant-by-id.md): Extract the single applicant with more details. Need to pass the auth token as the Bearer Token along with the applicant id in the URL. The response contains the standard fields and also the custom fields that are created by the clients.
• [Submissions](https://developer.ceipal.com/ceipalats/submissions.md): This object represents a submission on the client's account. Below are the endpoints that can be used to extract the submissions with various filters. Also there is a POST endpoint to submit an applicant to a job. Typically the clients who use to build the career portal through these APIs can use the POST endpoint to submit the applicants through the endpoint. Rate limit applies to these endpoints based on the API Key.
  • [Get Submissions](https://developer.ceipal.com/ceipalats/submissions/get-submissions.md): Retrieves the submissions for the given auth token. Need to pass the auth token as the Bearer Token to get the jobs listing.
  • [Get Submission By ID](https://developer.ceipal.com/ceipalats/submissions/get-submission-by-id.md): Extract the single submission with more details. Need to pass the auth token as the Bearer Token along with the submission id in the URL. The response contains the standard fields and also the custom fields that are created by the clients.
• [Clients](https://developer.ceipal.com/ceipalats/clients.md): This object represents a client on the client's account. Below are the endpoints that can be used to extract the clients with various filters. Rate limit applies to these endpoints based on the API Key.
  • [Get Clients](https://developer.ceipal.com/ceipalats/clients/get-clients.md): Retrieves all the clients for the given auth token. Need to pass the auth token as the Bearer Token to get the jobs listing.
  • [Get Client By ID](https://developer.ceipal.com/ceipalats/clients/get-client-by-id.md): Extract the client with more details. Need to pass the auth token as the Bearer Token along with the client id in the URL. The response contains the standard fields and also the custom fields that are created by the clients.
• [Placements](https://developer.ceipal.com/ceipalats/placements.md): This object represents a placement on the client's account. Below are the endpoints that can be used to extract the placements with various filters. Rate limit applies to these endpoints based on the API Key.
  • [Get Placements](https://developer.ceipal.com/ceipalats/placements/get-placements.md): Retrieves all the placements for the given auth token. Need to pass the auth token as the Bearer Token to get the jobs listing.