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 band API

The band API from Charthop — 6 operation(s) for band.

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

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

This API exposes 10 operations across 6 paths, and defines 19 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

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

10 operations 6 paths 19 schemas 3 DELETE4 GET1 PATCH2 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 10

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

band 10
GET
/v1/org/{orgId}/band
Find comp bands in the organization
findCompBands 11 params → 200400401404
POST
/v1/org/{orgId}/band
Create a comp band
createCompBand 3 params → 202400401404
DELETE
/v1/org/{orgId}/band
Delete all comp bands on a date
deleteAllCompBands 2 params → 200
POST
/v1/org/{orgId}/band/bulkupdate
Perform a bulk update on comp bands
bulkUpdate 2 params → 200400401
GET
/v1/org/{orgId}/band/count
Return the count of comp bands in the organization
countCompBands 6 params → 200400401404
DELETE
/v1/org/{orgId}/band/reset
Delete all comp band data on a date
resetCompBands 2 params → 200
GET
/v1/org/{orgId}/band/schema
Get comp band schema with job tier field configurations and their possible values
getCompBandSchema 2 params → 200400401404
GET
/v1/org/{orgId}/band/{bandId}
Return a particular comp band by id on an effective date
getCompBandById 3 params → 200400401404
PATCH
/v1/org/{orgId}/band/{bandId}
Update a comp band
updateCompBand 4 params → 202400401404
DELETE
/v1/org/{orgId}/band/{bandId}
Delete a comp band
deleteCompBand 3 params → 202400401404

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are CompBand (38 properties), Process (29 properties), CreateCompBand (22 properties), UpdateCompBand (22 properties). Each schema is shown below with its type and property counts.

LogData
object
4 properties 3 required
Translations
object
1 property 1 required
CreateCompBand
object
22 properties 4 required
JobTierField
object
2 properties 1 required
Process
object
29 properties 9 required
ResultsCompBand
object
3 properties 1 required
AccessAction
object
3 properties 1 required
CompBandCount
object
1 property 1 required
Attribution
object
6 properties
CompBandUpdateOperation
object
2 properties 2 required
CompBandSchema
object
5 properties 2 required
CompBand
object
38 properties 5 required
TableRowRef
object
4 properties 3 required
ResultsAccess
object
2 properties 1 required
EnumValue
object
9 properties 2 required
Money
object
3 properties 2 required
BulkCompBandUpdateRequest
object
2 properties 1 required
JobTierFieldSchema
object
2 properties 1 required
UpdateCompBand
object
22 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-band-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