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

> 29 actions available for Flatchr through StackOne. Use via Actions RPC, Toolset SDK, MCP, or A2A.

<div className="not-prose" style={{ display: 'flex', alignItems: 'center', gap: '12px', marginBottom: '24px' }}>
  <img src="https://stackone-logos.com/api/flatchr/filled/png" alt="Flatchr" className="connector-page-icon" style={{ width: '48px', height: '48px', borderRadius: '10px', padding: '2px' }} />

  <div>
    <div style={{ fontSize: '24px', fontWeight: '600' }}>Flatchr</div>
    <div className="connector-page-subtitle" style={{ fontSize: '14px' }}>29 actions · 1 auth method</div>

    <div style={{ display: 'flex', flexWrap: 'wrap', gap: '6px', marginTop: '8px' }}>
      <span className="connector-page-tag-beta" style={{ display: 'inline-block', padding: '2px 8px', borderRadius: '4px', fontSize: '11px', fontWeight: '500' }}>Beta</span>
      <span className="connector-page-category-tag" style={{ display: 'inline-block', padding: '2px 8px', borderRadius: '4px', fontSize: '11px', fontWeight: '500' }}>ATS</span>
    </div>
  </div>
</div>

## Authentication

<Columns cols={2}>
  <Card title="API Key">
    Flatchr uses a static API key sent as a Bearer token. Generate it in your account under Settings > Advanced > API, where...

    Guides: [Connector Profile](/connectors/flatchr/guides/connector-profile/api-key), [Link Account](/connectors/flatchr/guides/link-account/api-key)
  </Card>
</Columns>

<div className="connector-meta-library-section">
  <div className="connector-meta-library-title">Actions</div>

  <div className="connector-actions-controls not-prose" data-connector-actions-controls>
    <div className="connector-actions-controls__row">
      <input type="search" className="connector-actions-search" data-connector-actions-search placeholder="Search actions" aria-label="Search actions" />
    </div>
  </div>

  <div className="meta-library-count" data-connector-actions-count>29 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid" style={{ gridTemplateColumns: '200px 1fr' }}>
      <div className="connector-meta-library-row">
        <div className="meta-library-grid-header-cell">Action</div>
        <div className="meta-library-grid-header-cell">Description</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_vacancies" data-action-label="Retrieve Vacancies" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Vacancies</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_vacancies" aria-label="Copy flatchr_retrieve_vacancies"><code className="connector-page-code">flatchr\_retrieve\_vacancies</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List all vacancies (job ads) for your company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_active_vacancies" data-action-label="Retrieve Active Vacancies" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Active Vacancies</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_active_vacancies" aria-label="Copy flatchr_retrieve_active_vacancies"><code className="connector-page-code">flatchr\_retrieve\_active\_vacancies</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the active, publicly published vacancies for your company career site.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_vacancy" data-action-label="Retrieve Vacancy" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Vacancy</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_vacancy" aria-label="Copy flatchr_retrieve_vacancy"><code className="connector-page-code">flatchr\_retrieve\_vacancy</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a single vacancy by its ID.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_create_vacancy" data-action-label="Create Vacancy" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Create Vacancy</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_create_vacancy" aria-label="Copy flatchr_create_vacancy"><code className="connector-page-code">flatchr\_create\_vacancy</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new vacancy (job ad) for your company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_search_candidates" data-action-label="Search Candidates" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Search Candidates</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_search_candidates" aria-label="Copy flatchr_search_candidates"><code className="connector-page-code">flatchr\_search\_candidates</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Searches candidates (applicants) for a company in Flatchr using filters such as name, email, pipeline stage (column), jo...</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_update_candidate_meta_information" data-action-label="Update Candidate Meta Information" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Update Candidate Meta Information</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_update_candidate_meta_information" aria-label="Copy flatchr_update_candidate_meta_information"><code className="connector-page-code">flatchr\_update\_candidate\_meta\_information</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Adds or updates meta information on an existing candidate (applicant) in Flatchr, identified by their email reference.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_move_candidate" data-action-label="Move Candidate" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Move Candidate</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_move_candidate" aria-label="Copy flatchr_move_candidate"><code className="connector-page-code">flatchr\_move\_candidate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Moves a candidate to a different column (pipeline stage) within a vacancy in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_archive_candidate" data-action-label="Archive Candidate" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Archive Candidate</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_archive_candidate" aria-label="Copy flatchr_archive_candidate"><code className="connector-page-code">flatchr\_archive\_candidate</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Archives (removes) a candidate from a vacancy in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_create_candidate_json" data-action-label="Create Candidate (JSON)" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Create Candidate (JSON)</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_create_candidate_json" aria-label="Copy flatchr_create_candidate_json"><code className="connector-page-code">flatchr\_create\_candidate\_json</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a candidate application against a job vacancy using a JSON payload.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_create_candidate_custom" data-action-label="Create Candidate (Custom)" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Create Candidate (Custom)</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_create_candidate_custom" aria-label="Copy flatchr_create_candidate_custom"><code className="connector-page-code">flatchr\_create\_candidate\_custom</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a candidate application against a job vacancy using a custom payload.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_create_candidate_test" data-action-label="Create Candidate (Test)" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Create Candidate (Test)</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_create_candidate_test" aria-label="Copy flatchr_create_candidate_test"><code className="connector-page-code">flatchr\_create\_candidate\_test</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Test candidate creation against a job vacancy without creating a real record.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_candidate_cv" data-action-label="Retrieve Candidate CV" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Candidate CV</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_candidate_cv" aria-label="Copy flatchr_retrieve_candidate_cv"><code className="connector-page-code">flatchr\_retrieve\_candidate\_cv</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieves the downloadable CV document of a candidate in Flatchr using the unique CV key and file extension.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_comments" data-action-label="Retrieve Comments" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Comments</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_comments" aria-label="Copy flatchr_retrieve_comments"><code className="connector-page-code">flatchr\_retrieve\_comments</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the comments left on a Flatchr applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_create_comment" data-action-label="Create Comment" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Create Comment</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_create_comment" aria-label="Copy flatchr_create_comment"><code className="connector-page-code">flatchr\_create\_comment</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a comment on a Flatchr applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_delete_comment" data-action-label="Delete Comment" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Delete Comment</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_delete_comment" aria-label="Copy flatchr_delete_comment"><code className="connector-page-code">flatchr\_delete\_comment</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Delete a comment from a Flatchr applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_messages" data-action-label="Retrieve Messages" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Messages</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_messages" aria-label="Copy flatchr_retrieve_messages"><code className="connector-page-code">flatchr\_retrieve\_messages</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the messages exchanged with a Flatchr applicant.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_tasks" data-action-label="Retrieve Tasks" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Tasks</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_tasks" aria-label="Copy flatchr_retrieve_tasks"><code className="connector-page-code">flatchr\_retrieve\_tasks</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the recruitment tasks for the configured company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_create_task" data-action-label="Create Task" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Create Task</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_create_task" aria-label="Copy flatchr_create_task"><code className="connector-page-code">flatchr\_create\_task</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a recruitment task for the configured company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_close_task" data-action-label="Close Task" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Close Task</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_close_task" aria-label="Copy flatchr_close_task"><code className="connector-page-code">flatchr\_close\_task</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Close (mark as done) a recruitment task for the configured company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_display_candidate_tags" data-action-label="Display Candidate Tags" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Display Candidate Tags</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_display_candidate_tags" aria-label="Copy flatchr_display_candidate_tags"><code className="connector-page-code">flatchr\_display\_candidate\_tags</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the tags attached to a Flatchr candidate.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_fill_a_candidate_tag" data-action-label="Fill A Candidate Tag" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Fill A Candidate Tag</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_fill_a_candidate_tag" aria-label="Copy flatchr_fill_a_candidate_tag"><code className="connector-page-code">flatchr\_fill\_a\_candidate\_tag</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Add a tag (trait) to a Flatchr candidate.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_retrieve_company_tags" data-action-label="Retrieve Company Tags" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>Retrieve Company Tags</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_retrieve_company_tags" aria-label="Copy flatchr_retrieve_company_tags"><code className="connector-page-code">flatchr\_retrieve\_company\_tags</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the tags configured for the company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_members" data-action-label="List Members" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Members</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_members" aria-label="Copy flatchr_list_members"><code className="connector-page-code">flatchr\_list\_members</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the members (users) belonging to the company.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_columns" data-action-label="List Columns" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Columns</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_columns" aria-label="Copy flatchr_list_columns"><code className="connector-page-code">flatchr\_list\_columns</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the columns (pipeline stages) configured for a company in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_business_sectors" data-action-label="List Business Sectors" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Business Sectors</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_business_sectors" aria-label="Copy flatchr_list_business_sectors"><code className="connector-page-code">flatchr\_list\_business\_sectors</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve the list of business sectors (industry categories) used in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_channels" data-action-label="List Channels" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Channels</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_channels" aria-label="Copy flatchr_list_channels"><code className="connector-page-code">flatchr\_list\_channels</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the job board channels available for distributing vacancies in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_channel_job_categories" data-action-label="List Channel Job Categories" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Channel Job Categories</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_channel_job_categories" aria-label="Copy flatchr_list_channel_job_categories"><code className="connector-page-code">flatchr\_list\_channel\_job\_categories</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the job categories available for a specific channel in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_contract_types" data-action-label="List Contract Types" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Contract Types</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_contract_types" aria-label="Copy flatchr_list_contract_types"><code className="connector-page-code">flatchr\_list\_contract\_types</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the contract types reference data available in Flatchr.</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="flatchr_list_education_levels" data-action-label="List Education Levels" data-action-scopes="">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div style={{ fontWeight: '500' }}>List Education Levels</div>
          <div style={{ marginTop: '4px' }}><button type="button" className="connector-page-code-button" data-copy="flatchr_list_education_levels" aria-label="Copy flatchr_list_education_levels"><code className="connector-page-code">flatchr\_list\_education\_levels</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">List the available education levels reference data from Flatchr.</div>
      </div>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See the [Projects Guide](/guides/managing-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a connector profile in your project. See [Managing Connectors](/guides/explore-connectors).

    <Columns cols={2}>
      <Card title="Connector Profile" href="/connectors/flatchr/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/flatchr/filled/png" horizontal>
        Flatchr - API Key
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Connect an account using [StackOne Hub](/guides/embedding-stackone-hub) or [Auth Link](/guides/auth-link).

    <Columns cols={2}>
      <Card title="Link Account" href="/connectors/flatchr/guides/link-account/api-key" icon="https://stackone-logos.com/api/flatchr/filled/png" horizontal>
        Flatchr - API Key
      </Card>
    </Columns>
  </Step>

  <Step title="Use Actions">
    Invoke actions using one of the methods below:

    * [MCP](/mcp/quickstart) – Model Context Protocol for AI assistants
    * [A2A](/a2a/quickstart) – Agent-to-Agent protocol
    * [AI Toolset (TypeScript)](/agents/typescript/introduction) – TypeScript SDK for AI agents
    * [AI Toolset (Python)](/agents/python/introduction) – Python SDK for AI agents
    * [Actions RPC](/platform/api-reference/actions/make-an-rpc-call-to-an-action) – Direct API calls
    * [Playground](/guides/playground) – Test actions in the dashboard
  </Step>
</Steps>