Charthop comp-review API
The comp-review API from Charthop — 25 operation(s) for comp-review.
Charthop comp-review API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include comp-review. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 28 operations across 25 paths, and defines 82 schemas. It is described by OpenAPI 2.0, at version V1.0.0.
Requests are made against the base URL https://api.charthop.com.
28 operations
25 paths
82 schemas
1 DELETE11 GET2 PATCH14 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 28
Across 25 paths, the API surfaces 28 operations — 1 DELETE, 11 GET, 2 PATCH, 14 POST. Each is listed below with its method, path, parameters, and response codes.
comp-review 28
GET
/v1/org/{orgId}/comp-review
Find comp reviews in the organization
POST
/v1/org/{orgId}/comp-review
Create a comp review
POST
/v1/org/{orgId}/comp-review/bulk/delete
Delete a set of comp reviews
POST
/v1/org/{orgId}/comp-review/bulk/duplicate
Duplicate a set of comp reviews
GET
/v1/org/{orgId}/comp-review/{compReviewId}
Return a particular comp review by ID
PATCH
/v1/org/{orgId}/comp-review/{compReviewId}
Update a comp review
DELETE
/v1/org/{orgId}/comp-review/{compReviewId}
Delete a comp review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/approval-requests
Get a list of approval request responses for a given comp review
PATCH
/v1/org/{orgId}/comp-review/{compReviewId}/approval-requests/{approvalRequestId}
Update approval request status, including any rollups
GET
/v1/org/{orgId}/comp-review/{compReviewId}/associated-entities
Get the necessary caches on a specific date for a compensation review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/audit-log
Return past events, paginated, without payloads present
POST
/v1/org/{orgId}/comp-review/{compReviewId}/conclude
Concludes (or closes) the compensation review
POST
/v1/org/{orgId}/comp-review/{compReviewId}/dry-run
Preview changes that will occur when resuming a paused comp review
POST
/v1/org/{orgId}/comp-review/{compReviewId}/duplicate
Duplicate a comp review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/eligible-employees
Get a list of employees eligible for a given comp review
POST
/v1/org/{orgId}/comp-review/{compReviewId}/export
Export a comp review's changes
POST
/v1/org/{orgId}/comp-review/{compReviewId}/export/audit
Export a comp review's audit log
POST
/v1/org/{orgId}/comp-review/{compReviewId}/export/comments
Export a comp review's comments
POST
/v1/org/{orgId}/comp-review/{compReviewId}/generate
Generate a compensation review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle
Get an overview for a given user in an in-cycle comp-review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle/changes
Get the changes for a set of scenarios in an in-cycle comp-review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle/changes/{changeId}
Get the change data and guideline flags associated with an in-cycle change
GET
/v1/org/{orgId}/comp-review/{compReviewId}/in-cycle/collabicient
Get a collaborator participant reviewer in-cycle comp-review
GET
/v1/org/{orgId}/comp-review/{compReviewId}/metadata
Return metadata for a particular comp review by ID
POST
/v1/org/{orgId}/comp-review/{compReviewId}/pause
Pauses the compensation review to allow for editing by an admin
POST
/v1/org/{orgId}/comp-review/{compReviewId}/preview
Generate tiering & preview for a compensation review
POST
/v1/org/{orgId}/comp-review/{compReviewId}/send-reminder-email
Send a reminder email to someone participating in a comp review
POST
/v1/org/{orgId}/comp-review/{compReviewId}/visualizations
Get data for visualizations for a comp review
Schemas 82
The contract defines 82 schemas that model the data the API accepts and returns. The most detailed are Field (47 properties), Change (46 properties), Scenario (37 properties), PartialJob (31 properties). Each schema is shown below with its type and property counts.
ApprovalGroup
object
5 properties
2 required
LogData
object
4 properties
3 required
CompReviewReviewerWorkbook
object
6 properties
1 required
OwnershipChange
object
5 properties
3 required
DtValue
object
1 property
ResultsCompReview
object
3 properties
1 required
CompReviewBudgets
object
7 properties
4 required
AutoIncFieldConfig
object
4 properties
4 required
Contact
object
3 properties
2 required
Change
object
46 properties
6 required
TimeOff
object
8 properties
3 required
ResultsAccess
object
2 properties
1 required
EnumValue
object
9 properties
2 required
GenerateCompReviewOptions
object
1 property
1 required
Event
object
22 properties
6 required
PartialJob
object
31 properties
Name
object
5 properties
1 required
Comp
object
5 properties
JobRelationship
object
2 properties
2 required
InCycleViewResponse
object
8 properties
BudgetCalculation
object
4 properties
1 required
CompReviewEligibleEmployees
object
8 properties
1 required
AccessAction
object
3 properties
1 required
InCycleViewFeatures
object
6 properties
5 required
RevieweeMove
object
6 properties
3 required
ScenarioSharedViewConfig
object
5 properties
CompReviewDryRunResponse
object
Preview of changes that will occur when resuming a paused comp review
5 properties
5 required
VariableComp
object
variable compensation Implementations: VariableCompPercent, VariableCompPercent
2 properties
2 required
ApprovalRequestCompReviewResponse
object
12 properties
6 required
CompReviewConfig
object
8 properties
5 required
ResultsEvent
object
3 properties
1 required
Scenario
object
37 properties
11 required
InCycleViewChanges
object
3 properties
1 required
CompReview
object
20 properties
5 required
CompReviewKeyDates
object
8 properties
3 required
TiersResponse
object
2 properties
2 required
CostImpact
object
3 properties
3 required
SendReminderEmailOptions
object
1 property
1 required
RevieweeChange
object
4 properties
2 required
Translations
object
1 property
1 required
FieldOptions
object
15 properties
Process
object
29 properties
9 required
TierRepresentationResponse
object
4 properties
3 required
TableRef
object
2 properties
Geopoint
object
2 properties
2 required
Attribution
object
6 properties
DuplicateCompReviewOptions
object
3 properties
3 required
GuidelineCalculation
object
14 properties
9 required
CreateCompReview
object
4 properties
1 required
BudgetAllocation
object
2 properties
Deviation
object
2 properties
CompReviewNotifications
object
1 property
1 required
PartialAppEntities
object
4 properties
4 required
ChangeData
object
4 properties
3 required
UpdateCompReview
object
6 properties
ShareAccess
object
4 properties
1 required
OrgAccess
object
11 properties
2 required
Address
object
9 properties
1 required
ApprovalRequestPatchBody
object
2 properties
1 required
JobUpdate
object
19 properties
ApprovalGroupApprover
object
8 properties
2 required
CollaboratorMatrixCondition
object
2 properties
2 required
ResultsData
object
4 properties
1 required
PayInterval
object
6 properties
2 required
Field
object
47 properties
8 required
CompReviewReviewersApprovers
object
6 properties
1 required
PoolCalculation
object
5 properties
4 required
CollaboratorMatrix
object
2 properties
2 required
CompReviewWorkbookColumn
object
9 properties
6 required
CompReviewVisualizations
object
2 properties
1 required
Money
object
3 properties
2 required
InCycleChange
object
2 properties
2 required
Job
object
21 properties
5 required
UpcomingChange
object
6 properties
1 required
Person
object
25 properties
2 required
StockGrant
object
20 properties
7 required
AutoIncFieldPart
object
3 properties
2 required
CompReviewCollaborators
object
5 properties
3 required
CompReviewMetadata
object
9 properties
9 required
GetVisualizationsOptions
object
5 properties
1 required
ApprovalChainStageOverride
object
5 properties
4 required
ScenarioCalculation
object
3 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Charthop 12
Other APIs Charthop publishes across the network.
Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API
#comp-review