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

# Flatchr

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

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

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

[29 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/flatchr/guides/connector-profile/api-key.md)
>
> Flatchr uses a static API key sent as a Bearer token. Generate it in your account under Settings > Advanced > API, where...

**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/flatchr/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

29 actions

ActionDescription

Retrieve Vacancies`flatchr_retrieve_vacancies`

List all vacancies (job ads) for your company.

Retrieve Active Vacancies`flatchr_retrieve_active_vacancies`

List the active, publicly published vacancies for your company career site.

Retrieve Vacancy`flatchr_retrieve_vacancy`

Get a single vacancy by its ID.

Create Vacancy`flatchr_create_vacancy`

Create a new vacancy (job ad) for your company.

Search Candidates`flatchr_search_candidates`

Searches candidates (applicants) for a company in Flatchr using filters such as name, email, pipeline stage (column), jo...

Update Candidate Meta Information`flatchr_update_candidate_meta_information`

Adds or updates meta information on an existing candidate (applicant) in Flatchr, identified by their email reference.

Move Candidate`flatchr_move_candidate`

Moves a candidate to a different column (pipeline stage) within a vacancy in Flatchr.

Archive Candidate`flatchr_archive_candidate`

Archives (removes) a candidate from a vacancy in Flatchr.

Create Candidate (JSON)`flatchr_create_candidate_json`

Create a candidate application against a job vacancy using a JSON payload.

Create Candidate (Custom)`flatchr_create_candidate_custom`

Create a candidate application against a job vacancy using a custom payload.

Create Candidate (Test)`flatchr_create_candidate_test`

Test candidate creation against a job vacancy without creating a real record.

Retrieve Candidate CV`flatchr_retrieve_candidate_cv`

Retrieves the downloadable CV document of a candidate in Flatchr using the unique CV key and file extension.

Retrieve Comments`flatchr_retrieve_comments`

Retrieve the comments left on a Flatchr applicant.

Create Comment`flatchr_create_comment`

Create a comment on a Flatchr applicant.

Delete Comment`flatchr_delete_comment`

Delete a comment from a Flatchr applicant.

Retrieve Messages`flatchr_retrieve_messages`

Retrieve the messages exchanged with a Flatchr applicant.

Retrieve Tasks`flatchr_retrieve_tasks`

List the recruitment tasks for the configured company.

Create Task`flatchr_create_task`

Create a recruitment task for the configured company.

Close Task`flatchr_close_task`

Close (mark as done) a recruitment task for the configured company.

Display Candidate Tags`flatchr_display_candidate_tags`

Retrieve the tags attached to a Flatchr candidate.

Fill A Candidate Tag`flatchr_fill_a_candidate_tag`

Add a tag (trait) to a Flatchr candidate.

Retrieve Company Tags`flatchr_retrieve_company_tags`

List the tags configured for the company.

List Members`flatchr_list_members`

List the members (users) belonging to the company.

List Columns`flatchr_list_columns`

Retrieve the columns (pipeline stages) configured for a company in Flatchr.

List Business Sectors`flatchr_list_business_sectors`

Retrieve the list of business sectors (industry categories) used in Flatchr.

List Channels`flatchr_list_channels`

List the job board channels available for distributing vacancies in Flatchr.

List Channel Job Categories`flatchr_list_channel_job_categories`

List the job categories available for a specific channel in Flatchr.

List Contract Types`flatchr_list_contract_types`

List the contract types reference data available in Flatchr.

List Education Levels`flatchr_list_education_levels`

List the available education levels reference data from Flatchr.


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