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

# ChartHop

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

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

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

[67 actions](#actions) · 1 auth method

HRIS
IAM

## 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] [Bearer Token · Connector Profile](https://docs.stackone.com/connectors/charthop/guides/connector-profile/bearer-token.md)
>
> Requires a ChartHop app API token. Apps are created by emailing [support@charthop.com](mailto:support@charthop.com). The token is generated when ChartH...

**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] [Bearer Token · Link Account](https://docs.stackone.com/connectors/charthop/guides/link-account/bearer-token.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

67 actions

ActionDescription

List Jobs`charthop_list_jobs`

Find jobs and people in the organization with filtering, pagination, and field selection

Get Job`charthop_get_job`

Get detailed information about a specific job or person by their job ID

Create Job`charthop_create_job`

Create a new job (open position or filled role) in the organization

Update Job`charthop_update_job`

Update an existing job with new field values

Delete Job`charthop_delete_job`

Delete a job from the organization

List Persons`charthop_list_persons`

Find persons (employees) in the organization with filtering and pagination

Get Person`charthop_get_person`

Get detailed information about a specific person (employee) by their person ID

Create Person`charthop_create_person`

Create a new person record in the organization

Update Person`charthop_update_person`

Update an existing person record with new field values

Delete Person`charthop_delete_person`

Delete a person record from the organization

List Groups`charthop_list_groups`

Find groups (departments, teams, locations, cost centers) in the organization

Get Group`charthop_get_group`

Get detailed information about a specific group by its ID

Create Group`charthop_create_group`

Create a new group (department, team, location) in the organization

Update Group`charthop_update_group`

Update an existing group's details

Delete Group`charthop_delete_group`

Delete a group from the organization

List Changes`charthop_list_changes`

Retrieve the audit trail of organizational changes (hires, departures, moves, updates)

Get Change`charthop_get_change`

Get detailed information about a specific organizational change

List Events`charthop_list_events`

Retrieve organizational events (hire, depart, move, promote, update events)

Get Event`charthop_get_event`

Get detailed information about a specific organizational event

List Users`charthop_list_users`

Retrieve all users with system access to ChartHop

Get User`charthop_get_user`

Get a specific user by their user ID

Get Current User`charthop_get_current_user`

Get the current authenticated user (me) profile

Create User`charthop_create_user`

Create a new system user with login access to ChartHop

Update User`charthop_update_user`

Update an existing user's details

List Roles`charthop_list_roles`

Retrieve all custom roles defined in the organization

Get Role`charthop_get_role`

Get detailed information about a specific role

Create Role`charthop_create_role`

Create a new custom role with specified permission sets

Update Role`charthop_update_role`

Update an existing role's name, description, or permissions

Delete Role`charthop_delete_role`

Delete a custom role from the organization

List Scenarios`charthop_list_scenarios`

Retrieve all planning scenarios in the organization

Get Scenario`charthop_get_scenario`

Get detailed information about a specific planning scenario

Create Scenario`charthop_create_scenario`

Create a new planning scenario for modeling organizational changes

Update Scenario`charthop_update_scenario`

Update a planning scenario's details or status

Delete Scenario`charthop_delete_scenario`

Delete a planning scenario permanently

Merge Scenario`charthop_merge_scenario`

Merge an approved planning scenario into the primary organizational timeline

List Organizations`charthop_list_orgs`

Retrieve all organizations the authenticated user has access to

Get Organization`charthop_get_org`

Get detailed information about the organization

List Fields`charthop_list_fields`

Retrieve all custom field definitions for the organization

Get Field`charthop_get_field`

Get detailed information about a specific custom field

Create Field`charthop_create_field`

Create a new custom field definition for capturing organization-specific data

Update Field`charthop_update_field`

Update an existing custom field definition

Delete Field`charthop_delete_field`

Delete a custom field from the organization

List Field Categories`charthop_list_categories`

Retrieve all field categories used for organizing custom fields

Create Field Category`charthop_create_category`

Create a new field category for organizing custom fields

List Forms`charthop_list_forms`

Retrieve all forms including onboarding forms, surveys, and data collection templates

Get Form`charthop_get_form`

Get detailed information about a specific form

Update Form`charthop_update_form`

Update an existing form's configuration or questions

Delete Form`charthop_delete_form`

Delete a form from the organization

List Form Responses`charthop_list_form_responses`

Retrieve responses submitted for a specific form

List Compensation Reviews`charthop_list_comp_reviews`

Retrieve all compensation review cycles in the organization

Get Compensation Review`charthop_get_comp_review`

Get detailed information about a specific compensation review cycle

Create Compensation Review`charthop_create_comp_review`

Create a new compensation review cycle

Update Compensation Review`charthop_update_comp_review`

Update a compensation review cycle's details or status

List Compensation Bands`charthop_list_bands`

Retrieve all salary ranges and compensation band structures

Get Compensation Band`charthop_get_band`

Get details for a specific compensation band

Create Compensation Band`charthop_create_band`

Create a new compensation band defining salary ranges

Update Compensation Band`charthop_update_band`

Update an existing compensation band's salary ranges

List Time Off`charthop_list_time_off`

Retrieve time off requests for the organization

Get Time Off`charthop_get_time_off`

Get details for a specific time off request

Create Time Off Request`charthop_create_time_off`

Create a new time off request for an employee

Update Time Off Request`charthop_update_time_off`

Update an existing time off request

List Time Off Policies`charthop_list_time_off_policies`

Retrieve all time off policies (vacation, sick leave, PTO types)

Get Time Off Policy`charthop_get_time_off_policy`

Get details for a specific time off policy

List Tasks`charthop_list_tasks`

Retrieve all tasks in the organization

Get Task`charthop_get_task`

Get details for a specific task by task ID

List Processes`charthop_list_processes`

Retrieve all long-running process operations (imports, exports, syncs)

Get Process`charthop_get_process`

Get the status and details of a specific process operation


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