Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

Charthop

Charthop change API

The change API from Charthop — 14 operation(s) for change.

Documentation Provider Profile APIs.io OpenAPI GitHub

Charthop change API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include change. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 16 operations across 14 paths, and defines 29 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

16 operations 14 paths 29 schemas 1 DELETE6 GET2 PATCH7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
ChartHop
Resource Areas
1

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 1 DELETE, 6 GET, 2 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

change 16
GET
/v1/org/{orgId}/change
Return recent changes across an org, or for a particular person or job
findChanges 24 params → 200400401404
POST
/v1/org/{orgId}/change/bulkchange
Perform a series of changes at once
bulkChange 2 params → 200400404
POST
/v1/org/{orgId}/change/bulkupdate
Perform a bulk update on a number of jobs
bulkUpdate 2 params → 200400404
GET
/v1/org/{orgId}/change/compensation-history
Return enriched compensation history rows (one row per comp change), in descending date order
findCompensationHistory 7 params → 200400401404
POST
/v1/org/{orgId}/change/depart-rehire
Create a depart-rehire pair of changes, for filling in historical data
departRehire 3 params → 202400404
GET
/v1/org/{orgId}/change/scenario/{scenarioId}
Return all changes for a particular scenario, with before job
findScenarioChanges 6 params → 200400401404
POST
/v1/org/{orgId}/change/sync/{type}
Sync a change (create the change only if it does not already exist)
syncChange 4 params → 200400404
GET
/v1/org/{orgId}/change/{changeId}
Return a particular change by id
getChange 3 params → 200400404
PATCH
/v1/org/{orgId}/change/{changeId}
Make a change to a change
updateChange 4 params → 204400404
DELETE
/v1/org/{orgId}/change/{changeId}
Delete a previous change
deleteChange 3 params → 400404
POST
/v1/org/{orgId}/change/{changeId}/approve
Approve or reject a change
approveChange 3 params → 204400404
GET
/v1/org/{orgId}/change/{changeId}/approver
Given a of change id, see if the person can approve/reject
changeApprover 3 params → 200400401404
POST
/v1/org/{orgId}/change/{type}
Create a new change
createChange 5 params → 201400404
POST
/v1/org/{orgId}/change/{type}/validate
Validate a change
validateChange 3 params → 400404
PATCH
/v1/org/{orgId}/scenario/{scenarioId}/change/{changeId}
Amend a change within a scenario, and potentially return the updated data
updateScenarioChange 7 params → 200204400404
GET
/v1/org/{orgId}/scenario/{scenarioId}/change/{changeId}/status/{processId}
Get the status of a running change within a scenario
getChangeStatus 4 params → 200404

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are Change (46 properties), PartialJob (31 properties), Process (29 properties), StockGrant (20 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
JobRelationship
object
2 properties 2 required
JobUpdate
object
19 properties
ResultsChangeData
object
3 properties 1 required
CreateChange
object
19 properties
AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
PayInterval
object
6 properties 2 required
BulkUpdateRequest
object
5 properties 3 required
Attribution
object
6 properties
ResultsChange
object
3 properties 1 required
VariableComp
object
variable compensation Implementations: VariableCompPercent, VariableCompPercent
2 properties 2 required
UpdateChange
object
11 properties
ScenarioChangesWithBudgetRollup
object
3 properties 2 required
CompensationHistoryRow
object
12 properties 4 required
BulkChangeRequest
object
1 property 1 required
Change
object
46 properties 6 required
TimeOff
object
8 properties 3 required
ResultsAccess
object
2 properties 1 required
Money
object
3 properties 2 required
ResultsCompensationHistoryRow
object
3 properties 1 required
ApproveChange
object
3 properties 1 required
ChangeStatusResponse
object
2 properties 2 required
UpcomingChange
object
6 properties 1 required
UpdateScenarioChangeResponse
object
2 properties 2 required
StockGrant
object
20 properties 7 required
ChangeData
object
4 properties 3 required
PartialJob
object
31 properties
Comp
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-change-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
AE Profile APIs.io
Charthop action API
AE Profile APIs.io
Charthop ai API
AE Profile APIs.io
Charthop ai-credit-limit API
AE Profile APIs.io
Charthop ai-hint API
AE Profile APIs.io
Charthop ai-prompt API
AE Profile APIs.io
Charthop app API
AE Profile APIs.io
Charthop appConfig API
AE Profile APIs.io
Charthop approval API
AE Profile APIs.io
Charthop approval-delegate API
AE Profile APIs.io
Charthop approval-request API
AE Profile APIs.io
Charthop assessment API
AE Profile APIs.io
#change
← Back to C APIs
API Details
ID
charthop:charthop-change-api
Base URL
https://api.charthop.com
Docs
https://docs.charthop.com/charthop-for-developers
Provider
Charthop
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network