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

# Sage People

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

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

  <div className="connector-page-changelog">
    <div className="connector-page-version"><span className="connector-page-tag-beta connector-page-stage-tag">Beta</span><span>v1.0.0</span></div>
  </div>

  <div className="connector-page-header-meta">
    <div className="connector-page-subtitle"><a href="#actions">8 actions</a> · 2 auth methods</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 · OAuth 2.0 (Authorization Code)" href="/connectors/sagepeople/guides/connector-profile/oauth-2-0-authorization-code" icon="https://stackone-logos.com/api/sagepeople/filled/svg" horizontal>
        Standard Salesforce OAuth 2.0 authorization code flow. Requires a Connected App in the customer's Salesforce org with th...
      </Card>

      <Card title="Connector Profile · OAuth 2.0 (Username-Password — Legacy)" href="/connectors/sagepeople/guides/connector-profile/oauth-2-0-username-password-legacy" icon="https://stackone-logos.com/api/sagepeople/filled/svg" horizontal>
        Salesforce username-password OAuth2 flow. Deprecated by Salesforce in 2023+ and disabled by default on new orgs; include...
      </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 · OAuth 2.0 (Authorization Code)" href="/connectors/sagepeople/guides/link-account/oauth-2-0-authorization-code" icon="https://stackone-logos.com/api/sagepeople/filled/svg" horizontal />

      <Card title="Link Account · OAuth 2.0 (Username-Password — Legacy)" href="/connectors/sagepeople/guides/link-account/oauth-2-0-username-password-legacy" icon="https://stackone-logos.com/api/sagepeople/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 className="connector-actions-scopes" data-connector-actions-scopes>
        <button type="button" className="connector-actions-scopes__toggle" data-connector-actions-scopes-toggle aria-expanded="false">
          <span>Scopes<span data-connector-actions-scopes-count /></span>
        </button>

        <div className="connector-actions-scopes__menu">
          <div className="connector-actions-scopes__header">
            <input type="search" className="connector-actions-scopes__search" data-connector-actions-scope-search placeholder="Search scopes..." aria-label="Search scopes" />

            <div className="connector-actions-scopes__actions">
              <button type="button" data-connector-actions-scopes-select-all>Select all</button>
              <span>|</span>
              <button type="button" data-connector-actions-scopes-clear>Clear</button>
            </div>
          </div>

          <label className="connector-actions-scopes__item">
            <input type="checkbox" value="api" data-connector-actions-scope-filter />

            <span>api</span>
          </label>

          <div className="connector-actions-scopes__empty" data-connector-actions-scopes-empty hidden>No scopes found</div>
        </div>
      </div>
    </div>
  </div>

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

  <div className="not-prose meta-library-table-container" data-connector-actions-table>
    <div className="connector-meta-library-grid connector-meta-library-grid--three-col">
      <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 className="meta-library-grid-header-cell">Required scopes</div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_list_employees" data-action-label="List Employees" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Employees</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_list_employees" aria-label="Copy sagepeople_list_employees"><code className="connector-page-code">sagepeople\_list\_employees</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a paginated list of Sage People employees (workers). Backed by the Salesforce Team Member object (fHCM2\_\_Team\_Member...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_get_employee" data-action-label="Get Employee" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Get Employee</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_get_employee" aria-label="Copy sagepeople_get_employee"><code className="connector-page-code">sagepeople\_get\_employee</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a single Sage People employee by id. Returns the full employee record (profile, current employment, work address, ad...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_list_salaries" data-action-label="List Salaries" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#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="sagepeople_list_salaries" aria-label="Copy sagepeople_list_salaries"><code className="connector-page-code">sagepeople\_list\_salaries</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a paginated list of Sage People salary records (compensation). Backed by the Salesforce fHCM2\_\_Salary\_\_c object. Eac...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_list_bonuses" data-action-label="List Bonuses" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Bonuses</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_list_bonuses" aria-label="Copy sagepeople_list_bonuses"><code className="connector-page-code">sagepeople\_list\_bonuses</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a paginated list of Sage People bonus records (one-off compensation events). Backed by the Salesforce fHCM2\_\_Bonus\_\_...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_list_absences" data-action-label="List Absences" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Absences</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_list_absences" aria-label="Copy sagepeople_list_absences"><code className="connector-page-code">sagepeople\_list\_absences</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a paginated list of Sage People absence (leave) records. Backed by the Salesforce fHCM2\_\_Absence\_\_c object. Each rec...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_list_absence_balances" data-action-label="List Absence Balances" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Absence Balances</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_list_absence_balances" aria-label="Copy sagepeople_list_absence_balances"><code className="connector-page-code">sagepeople\_list\_absence\_balances</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a paginated list of Sage People absence balance records (PTO / accrual balances). Backed by the Salesforce fHCM2\_\_Ac...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_list_timesheets" data-action-label="List Timesheets" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>List Timesheets</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_list_timesheets" aria-label="Copy sagepeople_list_timesheets"><code className="connector-page-code">sagepeople\_list\_timesheets</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Get a paginated list of Sage People timesheet records. Backed by the Salesforce fHCM2\_\_Timesheet\_\_c object. Each record...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>

      <div className="connector-meta-library-row" data-action-id="sagepeople_create_employee_pay_details" data-action-label="Create Employee Pay Details" data-action-scopes="api" data-action-auth="OAuth 2.0 (Authorization Code),OAuth 2.0 (Username-Password — Legacy)" data-action-auth-scopes="{&#x22;OAuth 2.0 (Authorization Code)&#x22;:[],&#x22;OAuth 2.0 (Username-Password — Legacy)&#x22;:[]}">
        <div className="meta-library-grid-cell connector-meta-library-item-cell">
          <div>Create Employee Pay Details</div>
          <div className="connector-meta-library-item-sub"><button type="button" className="connector-page-code-button" data-copy="sagepeople_create_employee_pay_details" aria-label="Copy sagepeople_create_employee_pay_details"><code className="connector-page-code">sagepeople\_create\_employee\_pay\_details</code></button></div>
        </div>

        <div className="meta-library-grid-cell meta-library-grid-cell--description">Push payroll output into Sage People for a single employee. This is the only WRITE endpoint in the Sage People API — pay...</div>

        <div className="meta-library-grid-cell meta-library-grid-cell--values">
          <div className="connector-meta-library-values-list"><button type="button" className="connector-page-code-button" data-copy="api" aria-label="Copy scope api"><code className="connector-page-code">api</code></button></div>
        </div>
      </div>
    </div>
  </div>
</div>


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