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 job-code API

The job-code API from Charthop — 8 operation(s) for job-code.

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 11 operations across 8 paths, and defines 12 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

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

11 operations 8 paths 12 schemas 1 DELETE4 GET1 PATCH5 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 11

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

job-code 11
GET
/v1/org/{orgId}/job-code
Return all job codes in the organization paginated
findJobCodes 7 params → 200400401404
POST
/v1/org/{orgId}/job-code
Create a job code
createJobCode 2 params → 201400401403404
POST
/v1/org/{orgId}/job-code/export
Export job codes
exportJobCodes 2 params → 200400401404
POST
/v1/org/{orgId}/job-code/import
Import data from CSV file
importCsv 3 params → 202400401403
GET
/v1/org/{orgId}/job-code/import/download-template
Download a CSV template for a job code import
downloadImportCsvTemplate 1 param → 200400401403404
GET
/v1/org/{orgId}/job-code/linked-fields
Return all job code linked field IDs
getJobCodeLinkedFields 4 params → 200401404
POST
/v1/org/{orgId}/job-code/match
Start an async process that uses AI to suggest a JobCode for each job that does not yet have one. Poll GET /v1/org/{orgId}/process/{processId} for status; suggestions are written to process.results o…
matchJobsToJobCodes 2 params → 200400401403404
POST
/v1/org/{orgId}/job-code/match/{processId}/reset
Mark a completed JobCodeMatchProcessor process as reset. Writes state.hasReset = true so the frontend can force the matcher UI to reset after the user applies changes, instead of redisplaying the mat…
resetJobCodeMatch 2 params → 204400401403404
GET
/v1/org/{orgId}/job-code/{jobCodeId}
Return a particular job code by id
getJobCode 3 params → 200400404
PATCH
/v1/org/{orgId}/job-code/{jobCodeId}
Update an existing job code
updateJobCode 3 params → 204400401403404
DELETE
/v1/org/{orgId}/job-code/{jobCodeId}
Delete a job code
deleteJobCode 2 params → 204400401403404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Process (29 properties), JobCode (20 properties), CreateJobCode (7 properties), Attribution (6 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
Process
object
29 properties 9 required
LogData
object
4 properties 3 required
ResultsAccess
object
2 properties 1 required
JobCodeLinkedFieldsResponse
object
4 properties 1 required
JobCodeMatchRequest
object
2 properties
CreateJobCode
object
7 properties 3 required
Attribution
object
6 properties
JobCode
object
20 properties 4 required
TextRef
object
2 properties
JobCodeExportOptions
object
2 properties
ResultsJobCode
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-job-code-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
#job-code
← Back to C APIs
API Details
ID
charthop:charthop-job-code-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