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

# CharlieHR

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

<div className="connector-page-header">
  <img src="https://stackone-logos.com/api/charliehr/filled/svg" alt="CharlieHR" className="connector-page-icon" />

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span>v1.1.0</span></div>
    <div><a href="/connectors/charliehr/changelog">See changelog</a></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">22 actions</a> · 1 auth method</div>

    <div className="connector-page-category-tags">
      <span className="connector-page-category-tag">HRIS</span>
    </div>
  </div>
</div>

## Getting Started

<Steps>
  <Step title="Create or Select a Project">
    Set up a new project or select an existing one. See [Organizations & Projects](/gateway/concepts/organizations-and-projects).
  </Step>

  <Step title="Configure the Connector">
    Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](/gateway/quickstart#setup-connector-profile).

    <Columns cols={2}>
      <Card title="Connector Profile · API Key" href="/connectors/charliehr/guides/connector-profile/api-key" icon="https://stackone-logos.com/api/charliehr/filled/svg" horizontal>
        Admin or Super Admin access is required to generate API keys.
      </Card>
    </Columns>
  </Step>

  <Step title="Link an Account">
    Link an account [from the dashboard](/connect/managing-connectors/linking-accounts#link-from-the-dashboard) (or via [StackOne Hub](/embed/account-linking/overview)).

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

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

  <Step title="Use Actions">
    Connect an AI platform to the linked account's actions. See [AI Platforms](/connect/ai-platforms/overview).

    Other ways to call actions are listed in [Protocols & SDKs](/connect/protocols-and-sdks).
  </Step>
</Steps>

## Actions

<div className="connector-meta-library-section">
  <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>22 actions</div>

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid">
      <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="charliehr_list_bank_accounts" data-action-label="List Bank Accounts" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Bank Accounts</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_bank_accounts" aria-label="Copy charliehr_list_bank_accounts"><code className="connector-page-code">charliehr\_list\_bank\_accounts</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve bank account information for all team members</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_bank_account" data-action-label="Get Bank Account" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Bank Account</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_bank_account" aria-label="Copy charliehr_get_bank_account"><code className="connector-page-code">charliehr\_get\_bank\_account</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve bank account information for a specific team member</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_company" data-action-label="Get Company" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Company</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_company" aria-label="Copy charliehr_get_company"><code className="connector-page-code">charliehr\_get\_company</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve company information for the authenticated account</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_leave_allowances" data-action-label="List Leave Allowances" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Leave Allowances</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_leave_allowances" aria-label="Copy charliehr_list_leave_allowances"><code className="connector-page-code">charliehr\_list\_leave\_allowances</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve leave allowances for all team members</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_leave_requests" data-action-label="List Leave Requests" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Leave Requests</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_leave_requests" aria-label="Copy charliehr_list_leave_requests"><code className="connector-page-code">charliehr\_list\_leave\_requests</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all leave requests for the company</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_leave_request" data-action-label="Get Leave Request" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Leave Request</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_leave_request" aria-label="Copy charliehr_get_leave_request"><code className="connector-page-code">charliehr\_get\_leave\_request</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific leave request by ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_offices" data-action-label="List Offices" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Offices</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_offices" aria-label="Copy charliehr_list_offices"><code className="connector-page-code">charliehr\_list\_offices</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all offices for the company</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_office" data-action-label="Get Office" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Office</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_office" aria-label="Copy charliehr_get_office"><code className="connector-page-code">charliehr\_get\_office</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific office by ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_salaries" data-action-label="List Salaries" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Salaries</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_salaries" aria-label="Copy charliehr_list_salaries"><code className="connector-page-code">charliehr\_list\_salaries</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve salary information for all team members</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_salary" data-action-label="Get Salary" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Salary</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_salary" aria-label="Copy charliehr_get_salary"><code className="connector-page-code">charliehr\_get\_salary</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific salary record by ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_team_member_note_types" data-action-label="List Team Member Note Types" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Team Member Note Types</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_team_member_note_types" aria-label="Copy charliehr_list_team_member_note_types"><code className="connector-page-code">charliehr\_list\_team\_member\_note\_types</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all team member note types for the company</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_team_member_note_type" data-action-label="Get Team Member Note Type" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Team Member Note Type</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_team_member_note_type" aria-label="Copy charliehr_get_team_member_note_type"><code className="connector-page-code">charliehr\_get\_team\_member\_note\_type</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific team member note type by ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_create_team_member_note_type" data-action-label="Create Team Member Note Type" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Team Member Note Type</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_create_team_member_note_type" aria-label="Copy charliehr_create_team_member_note_type"><code className="connector-page-code">charliehr\_create\_team\_member\_note\_type</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new team member note type</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_team_members" data-action-label="List Team Members" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Team Members</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_team_members" aria-label="Copy charliehr_list_team_members"><code className="connector-page-code">charliehr\_list\_team\_members</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all team members for the company</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_team_member" data-action-label="Get Team Member" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Team Member</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_team_member" aria-label="Copy charliehr_get_team_member"><code className="connector-page-code">charliehr\_get\_team\_member</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific team member by ID</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_team_member_leave_allowance" data-action-label="Get Team Member Leave Allowance" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Team Member Leave Allowance</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_team_member_leave_allowance" aria-label="Copy charliehr_get_team_member_leave_allowance"><code className="connector-page-code">charliehr\_get\_team\_member\_leave\_allowance</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve leave allowance for a specific team member</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_team_member_leave_requests" data-action-label="Get Team Member Leave Requests" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Team Member Leave Requests</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_team_member_leave_requests" aria-label="Copy charliehr_get_team_member_leave_requests"><code className="connector-page-code">charliehr\_get\_team\_member\_leave\_requests</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve leave requests for a specific team member</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_team_member_salaries" data-action-label="Get Team Member Salaries" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Team Member Salaries</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_team_member_salaries" aria-label="Copy charliehr_get_team_member_salaries"><code className="connector-page-code">charliehr\_get\_team\_member\_salaries</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve salary history for a specific team member</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_team_member_notes" data-action-label="List Team Member Notes" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Team Member Notes</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_team_member_notes" aria-label="Copy charliehr_list_team_member_notes"><code className="connector-page-code">charliehr\_list\_team\_member\_notes</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all notes for a specific team member</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_create_team_member_note" data-action-label="Create Team Member Note" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Team Member Note</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_create_team_member_note" aria-label="Copy charliehr_create_team_member_note"><code className="connector-page-code">charliehr\_create\_team\_member\_note</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Create a new note for a specific team member</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_list_teams" data-action-label="List Teams" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Teams</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_list_teams" aria-label="Copy charliehr_list_teams"><code className="connector-page-code">charliehr\_list\_teams</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve all teams for the company</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="charliehr_get_team" data-action-label="Get Team" data-action-scopes="" data-action-auth="API Key" data-action-auth-scopes="{&#x22;API Key&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Team</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="charliehr_get_team" aria-label="Copy charliehr_get_team"><code className="connector-page-code">charliehr\_get\_team</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Retrieve a specific team by ID</div>
      </div>
    </div>
  </div>
</div>


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