> ## 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.

# Apploi

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

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

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

[25 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 create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/apploi/guides/connector-profile/api-key.md)
>
> Apploi uses a partner API key sent in the X-Api-Key header. Your API key is issued by Apploi when you register as a part...

**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:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/apploi/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/ai-platforms/overview.md).

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

## Actions

25 actions

ActionDescription

List Applicants`apploi_list_applicants`

Retrieve a paginated list of job applicants, optionally filtered by state, job, team, or date range.

Create Applicant`apploi_create_applicant`

Create a new job applicant record in Apploi.

Get Applicant`apploi_get_applicant`

Retrieve a single applicant by their application form ID.

Update Applicant`apploi_update_applicant`

Update an existing applicant by adding notes to their application.

List Applicant Statuses`apploi_list_applicant_statuses`

Retrieve the list of available applicant statuses configured for a team.

Update Applicant Status`apploi_update_applicant_status`

Update the status of one or more job applications in bulk.

Schedule Interview`apploi_schedule_interview`

Schedule or cancel an interview for a job applicant.

List Applicant Messages`apploi_list_applicant_messages`

Retrieve all messages associated with a job applicant.

Send Applicant Message`apploi_send_applicant_message`

Send a text or email message to a job applicant.

Get Applicant Preconfigured Documents`apploi_get_applicant_preconfigured_documents`

Retrieve preconfigured documents associated with a job applicant.

Submit Background Check Result`apploi_submit_background_check_result`

Submit the result of a background check for a job applicant.

Check Already Applied`apploi_check_already_applied`

Check whether a person has already applied to a specific job.

List Jobs`apploi_list_jobs`

Retrieve all job postings for the connected Apploi account.

Get Job`apploi_get_job`

Retrieve a single job posting by its ID.

Create Job`apploi_create_job`

Create a new job posting in Apploi.

Update Job`apploi_update_job`

Update an existing job posting by ID.

Search Jobs`apploi_search_jobs`

Search for job postings matching specified criteria with pagination support.

List Job Cities`apploi_list_job_cities`

Retrieve the list of cities where jobs are available.

List Job Industries`apploi_list_job_industries`

Retrieve the list of industries that have active job postings.

Upsert Job Attributes`apploi_upsert_job_attributes`

Create or update custom job attributes for a team.

Update AI Chat Subscription`apploi_update_ai_chat_subscription`

Enable or disable AI chat for specific jobs within a team.

List Application Form Templates`apploi_list_application_form_templates`

Retrieve application form templates available for a team.

Upsert Document Merge Fields`apploi_upsert_document_merge_fields`

Create or update merge fields for a document template.

Get Analytics Job Click`apploi_get_analytics_job_click`

Record and retrieve analytics data for a job click event.

Get Analytics Search`apploi_get_analytics_search`

Retrieve search analytics data with optional location and filter parameters.


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