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

Charthop budget-pool API

The budget-pool API from Charthop — 4 operation(s) for budget-pool.

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

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

This API exposes 7 operations across 4 paths, and defines 23 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

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

7 operations 4 paths 23 schemas 1 DELETE4 GET1 PATCH1 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
Resource Areas
1

Paths & Operations 7

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

budget-pool 7
GET
/v1/org/{orgId}/budget-pool
Get all budget pools for an org
findBudgetPools 2 params → 200400401404
POST
/v1/org/{orgId}/budget-pool
Create a new budget pool
createBudgetPool 2 params → 400401404
GET
/v1/org/{orgId}/budget-pool/{id}
Get a specific budget pool
findBudgetPool 2 params → 200400401404
PATCH
/v1/org/{orgId}/budget-pool/{id}
Update a budget pool
updateBudgetPool 3 params → 400401404
DELETE
/v1/org/{orgId}/budget-pool/{id}
Delete a budget pool
deleteBudgetPool 2 params → 400401404
GET
/v1/org/{orgId}/budget-pool/{id}/guidelines
Get the guidelines associated with a budget pool
getGuidelinesForBudgetPool 2 params → 200400404
GET
/v1/org/{orgId}/budget-pool/{id}/preview
Generate tiering & preview with the given budget calculated for the compensation review
previewBudget 2 params → 200400401404

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are BudgetPool (31 properties), Guideline (29 properties), Job (21 properties), CreateBudgetPool (17 properties). Each schema is shown below with its type and property counts.

ResultsBudgetPool
object
3 properties 1 required
UpdateBudgetPool
object
16 properties
JobRelationship
object
2 properties 2 required
BasisCondition
object
3 properties 1 required
BasisFieldMatrix
object
2 properties 2 required
AccessAction
object
3 properties 1 required
InCycleViewFeatures
object
6 properties 5 required
PayInterval
object
6 properties 2 required
BudgetPool
object
31 properties 7 required
MoneyRange
object
3 properties
Guideline
object
29 properties 10 required
Attribution
object
6 properties
VariableComp
object
variable compensation Implementations: VariableCompPercent, VariableCompPercent
2 properties 2 required
ValueRange
object
3 properties
ResultsAccess
object
2 properties 1 required
Money
object
3 properties 2 required
BudgetTiersResponse
object
2 properties 2 required
BudgetTierRepresentationResponse
object
5 properties 3 required
UpcomingChange
object
6 properties 1 required
Job
object
21 properties 5 required
CreateBudgetPool
object
17 properties 6 required
Comp
object
5 properties
ResultsGuideline
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-budget-pool-api-openapi.yml Raw ↑

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