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

CaptivateIQ Jobs API

The Jobs API from CaptivateIQ — 4 operation(s) for jobs.

CaptivateIQ Jobs API is one of 16 APIs that CaptivateIQ publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version v1.

Requests are made against a single base URL, https://api.captivateiq.com.

4 operations 4 paths 4 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
v1
Base URL
https://api.captivateiq.com/ciq/v1/
Authentication
API Key
Resource Areas
1

Authentication & Security 1

CaptivateIQ Jobs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (tokenAuth). By default, every request must be authenticated.

  • tokenAuth — Token-based authentication with required prefix "Token"

Paths & Operations 4

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

Jobs 4
GET
/ciq/v1/job-aggregations/
List Job Aggregation
job_aggregations_list 4 params → 200
GET
/ciq/v1/job-aggregations/{job_aggregation_id}/
Get Job Aggregation
job_aggregations_retrieve 1 param → 200
GET
/ciq/v1/jobs/
List Jobs
jobs_list 4 params → 200
GET
/ciq/v1/jobs/{id}/
Get Job
jobs_retrieve 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are JobAggregation (15 properties), Job (8 properties), JobMetadata (5 properties), PaginatedJobList (5 properties). Each schema is shown below with its type and property counts.

PaginatedJobList
object
5 properties
JobMetadata
object
5 properties
Job
object
8 properties 1 required
JobAggregation
object
15 properties 11 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-jobs-api-openapi.yml Raw ↑

Other APIs CaptivateIQ publishes across the network.

CaptivateIQ Attribute Worksheets API
CaptivateIQ Audit Logs API
CaptivateIQ Commission Plans API
CaptivateIQ Dashboards API
CaptivateIQ Data Workbooks API
CaptivateIQ Data Worksheets API
CaptivateIQ Employee Assumptions API
CaptivateIQ Employees API
CaptivateIQ Hierarchies API
CaptivateIQ Metadata API
CaptivateIQ Payouts API
CaptivateIQ Report Models API