> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# CEIPAL

> How to set up the CEIPAL connector, plus the actions that are available.

![CEIPAL](https://stackone-logos.com/api/ceipal/filled/svg)

Betav0.1.0[See changelog](https://docs.stackone.com/connectors/ceipal/changelog.md)

[51 actions](#actions) · 1 auth method

ATS

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · API Key](https://docs.stackone.com/connectors/ceipal/guides/connector-profile/api-key.md)**
>
> Exchanges an ATS admin email, API password and API key for a Bearer access token that lasts one hour. The connector requ...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](https://docs.stackone.com/connectors/ceipal/guides/link-account/api-key.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

51 actions

ActionDescription

List Applicants`ceipal_get_applicants_list`

List applicants with filters

Get Applicant Details`ceipal_get_applicant_details`

Retrieve one applicant profile, including contact details, skills, status and resume token

Update Applicant`ceipal_update_applicant`

Update an existing applicant

Create Applicant`ceipal_create_applicant`

Create an applicant with a resume

Create Applicant Notes`ceipal_create_applicant_notes`

Add notes to one or more applicants

Apply To Job Without Registration`ceipal_apply_job_without_registration`

Submit a job application for a candidate

List Talent Bench`ceipal_get_bench_list`

List talent bench consultants

Get Talent Bench Details`ceipal_get_bench_details`

Retrieve one bench consultant with contact details, skills and availability

List Clients`ceipal_get_clients_list`

List clients with filters

Get Client Details`ceipal_get_client_details`

Retrieve one client record with status, category, ownership and address details

List Client Notes`ceipal_get_client_notes_list`

Retrieve notes logged against clients and client contacts

List Client Contacts`ceipal_get_client_contacts_list`

Retrieve contacts belonging to client accounts, with name, designation and contact details

Download Document`ceipal_document_download`

Download an applicant resume

List Interviews`ceipal_get_interviews_list`

List interviews with filters

Get Interview Details`ceipal_get_interview_details`

Retrieve one interview with schedule, mode, round, venue and outcome

List Job Postings`ceipal_get_job_postings_list`

List job postings with filters

Get Job Posting Details`ceipal_get_job_posting_details`

Retrieve one job posting with rates, location, recruiters, client and descriptions

Update Job Posting`ceipal_update_job_posting`

Update one or more job postings

List Leads`ceipal_get_leads_list`

Retrieve sales leads (prospective clients) with location, ownership and industry

Get Lead Details`ceipal_get_leads_detail`

Retrieve one sales lead with business unit, location, ownership and industry

List Job Types`ceipal_get_job_types_list`

Retrieve CEIPAL job types master data

List Domains`ceipal_get_domains_list`

Retrieve CEIPAL job domains master data

List Job Categories`ceipal_get_job_categories_list`

Retrieve CEIPAL job categories master data

List Applicant Statuses`ceipal_get_applicant_status_list`

Retrieve CEIPAL applicant statuses master data

List Applicant Sources`ceipal_get_sources_list`

Retrieve CEIPAL applicant sources master data

List Business Units`ceipal_get_business_units_list`

Retrieve CEIPAL business units master data

List Countries`ceipal_get_countries_list`

Retrieve CEIPAL countries master data

List Client Categories`ceipal_get_client_categories_list`

Retrieve CEIPAL client categories master data

List Client Statuses`ceipal_get_client_statuses_list`

Retrieve CEIPAL client statuses master data

List Clearance Types`ceipal_get_clearance_types_list`

Retrieve CEIPAL security clearance types master data

List Employment Types`ceipal_get_employment_types_list`

Retrieve CEIPAL employment types master data

List Industries`ceipal_get_industries_list`

Retrieve CEIPAL industries master data

List Job Statuses`ceipal_get_job_status_list`

Retrieve CEIPAL job statuses master data

List Pay Frequency Types`ceipal_get_pay_frequency_types_list`

Retrieve CEIPAL pay frequency types master data

List States`ceipal_get_states_list`

Retrieve CEIPAL states for a country master data

List Work Authorizations`ceipal_get_work_authorizations_list`

Retrieve CEIPAL work authorization types master data

List Departments`ceipal_get_departments_list`

Retrieve CEIPAL departments master data

List Notice Periods`ceipal_get_notice_period_list`

Retrieve CEIPAL notice period options master data

List Race And Ethnicity Options`ceipal_get_race_ethnicity_list`

Retrieve CEIPAL race and ethnicity options master data

List Applicant Note Actions`ceipal_get_applicant_note_actions_list`

Retrieve CEIPAL applicant note action types

List Priorities`ceipal_get_priorities_list`

Retrieve CEIPAL priority master data

List Placements`ceipal_get_placements_list`

List placements with filters

Get Placement Details`ceipal_get_placement_details`

Retrieve one placement with payment details, overheads and client details

List Job Requisitions`ceipal_get_requisitions_list`

List job requisitions with filters

Get Job Requisition Details`ceipal_get_requisitions_details`

Retrieve one job requisition with hiring manager, rates, status and attachments

List Submissions`ceipal_get_submissions_list`

List submissions with filters

Get Submission Details`ceipal_get_submission_details`

Retrieve one submission with pipeline status, rates, documents and tagging details

List Users`ceipal_get_users_list`

Retrieve recruiters and other ATS user accounts with status and reporting lines

Get User Details`ceipal_get_user_details`

Retrieve one ATS user account with contact details, status and business unit

List Vendors`ceipal_get_vendors_list`

Retrieve vendor (supplier) companies with contact details and ownership

Get Vendor Details`ceipal_get_vendor_details`

Retrieve one vendor company with contact details, ownership and technologies


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.