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

The job API from Charthop — 10 operation(s) for job.

Charthop job 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. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

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

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

13 operations 10 paths 11 schemas 1 DELETE9 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 13

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

job 13
GET
/v2/org/{orgId}/job
Find jobs in the organization
findJobs 18 params → 200202400401404
POST
/v2/org/{orgId}/job
Create a job
createJob 4 params → 201202400401404
POST
/v2/org/{orgId}/job/bulkupdate
Perform a bulk update on a number of jobs
bulkUpdate 3 params → 200400404
GET
/v2/org/{orgId}/job/count
Count jobs or people in the organization
countJobs 6 params → 200202400401404
GET
/v2/org/{orgId}/job/graph
Retrieve jobs from a region of the job graph
findJobsGraph 11 params → 200401404
GET
/v2/org/{orgId}/job/group-by
Find jobs in the organization, grouped by an expression
findJobsGrouped 10 params → 200202400401404
GET
/v2/org/{orgId}/job/person/{personIds}
Find jobs by person ids
getJobsByPersonIds 6 params → 200400
GET
/v2/org/{orgId}/job/subcounts
Compute top-N + Other subcounts for one or more fields, for jobs in the organization
getJobSubcounts 8 params → 200202400401404
GET
/v2/org/{orgId}/job/timeseries
Find jobs in the organization returned as a time-series
findJobsTimeseries 10 params → 200202400401404
GET
/v2/org/{orgId}/job/total
Compute aggregated totals for jobs matching a query
getJobTotals 7 params → 200202400401404
GET
/v2/org/{orgId}/job/{jobId}
Return a particular job by id
getJob 6 params → 200400404
PATCH
/v2/org/{orgId}/job/{jobId}
Update a job
updateJob 5 params → 202400401404
DELETE
/v2/org/{orgId}/job/{jobId}
Delete a job
deleteJob 4 params → 202400401404

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Process (29 properties), Attribution (6 properties), OrgCount (5 properties), UpdateOperation (4 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
FieldSubcount
object
3 properties 2 required
OrgCount
object
5 properties 4 required
ResultsAccess
object
2 properties 1 required
BulkJobPersonUpdateRequest
object
4 properties 2 required
Process
object
29 properties 9 required
LogData
object
4 properties 3 required
Attribution
object
6 properties
SubcountsResponse
object
1 property 1 required
UpdateOperation
object
4 properties 1 required
ResultsData
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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