Actions

67 actions

Action

Description

List Jobs

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

Get Job

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

Create Job

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

Update Job

Update an existing job with new field values

Delete Job

Delete a job from the organization

List Persons

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

Get Person

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

Create Person

Create a new person record in the organization

Update Person

Update an existing person record with new field values

Delete Person

Delete a person record from the organization

List Groups

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

Get Group

Get detailed information about a specific group by its ID

Create Group

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

Update Group

Update an existing group's details

Delete Group

Delete a group from the organization

List Changes

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

Get Change

Get detailed information about a specific organizational change

List Events

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

Get Event

Get detailed information about a specific organizational event

List Users

Retrieve all users with system access to ChartHop

Get User

Get a specific user by their user ID

Get Current User

Get the current authenticated user (me) profile

Create User

Create a new system user with login access to ChartHop

Update User

Update an existing user's details

List Roles

Retrieve all custom roles defined in the organization

Get Role

Get detailed information about a specific role

Create Role

Create a new custom role with specified permission sets

Update Role

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

Delete Role

Delete a custom role from the organization

List Scenarios

Retrieve all planning scenarios in the organization

Get Scenario

Get detailed information about a specific planning scenario

Create Scenario

Create a new planning scenario for modeling organizational changes

Update Scenario

Update a planning scenario's details or status

Delete Scenario

Delete a planning scenario permanently

Merge Scenario

Merge an approved planning scenario into the primary organizational timeline

List Organizations

Retrieve all organizations the authenticated user has access to

Get Organization

Get detailed information about the organization

List Fields

Retrieve all custom field definitions for the organization

Get Field

Get detailed information about a specific custom field

Create Field

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

Update Field

Update an existing custom field definition

Delete Field

Delete a custom field from the organization

List Field Categories

Retrieve all field categories used for organizing custom fields

Create Field Category

Create a new field category for organizing custom fields

List Forms

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

Get Form

Get detailed information about a specific form

Update Form

Update an existing form's configuration or questions

Delete Form

Delete a form from the organization

List Form Responses

Retrieve responses submitted for a specific form

List Compensation Reviews

Retrieve all compensation review cycles in the organization

Get Compensation Review

Get detailed information about a specific compensation review cycle

Create Compensation Review

Create a new compensation review cycle

Update Compensation Review

Update a compensation review cycle's details or status

List Compensation Bands

Retrieve all salary ranges and compensation band structures

Get Compensation Band

Get details for a specific compensation band

Create Compensation Band

Create a new compensation band defining salary ranges

Update Compensation Band

Update an existing compensation band's salary ranges

List Time Off

Retrieve time off requests for the organization

Get Time Off

Get details for a specific time off request

Create Time Off Request

Create a new time off request for an employee

Update Time Off Request

Update an existing time off request

List Time Off Policies

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

Get Time Off Policy

Get details for a specific time off policy

List Tasks

Retrieve all tasks in the organization

Get Task

Get details for a specific task by task ID

List Processes

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

Get Process

Get the status and details of a specific process operation