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 Employee Assumptions API

The Employee Assumptions API from CaptivateIQ — 3 operation(s) for employee assumptions.

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

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

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

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

6 operations 3 paths 11 schemas 1 DELETE2 GET2 POST1 PUT

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 Employee Assumptions 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 6

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

Employee Assumptions 6
POST
/ciq/v1/employee-assumptions/
Create Employee Assumption
employee_assumptions_create body → 201
GET
/ciq/v1/employee-assumptions/
List Employee Assumptions
employee_assumptions_list 11 params → 200
POST
/ciq/v1/employee-assumptions/batch/
Batch Update Employee Assumptions
employee_assumptions_batch_create body → 200
DELETE
/ciq/v1/employee-assumptions/{id}/
Delete Employee Assumption
employee_assumptions_destroy 1 param → 200
GET
/ciq/v1/employee-assumptions/{id}/
Get Employee Assumption
employee_assumptions_retrieve 1 param → 200
PUT
/ciq/v1/employee-assumptions/{id}/
Update Employee Assumption
employee_assumptions_update 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are EmployeeAssumption (13 properties), EmployeeAssumptionUpsert (12 properties), EmployeeAssumptionUpdate (10 properties), EmployeeAssumptionCreate (9 properties). Each schema is shown below with its type and property counts.

PayoutCurrencyEnum
string
EmployeeAssumptionUpsert
object
12 properties 9 required
NullEnum
OpenAPIBatchResult
object
3 properties 3 required
PaginatedEmployeeAssumptionList
object
5 properties
EmployeeAssumptionUpdate
object
10 properties 6 required
OpenAPIDelete
object
3 properties
EmployeeAssumptionCreate
object
9 properties 4 required
EmployeeAssumption
object
13 properties 5 required
AssignmentTypeEnum
string
BatchUpdateEmployeeAssumptions
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-employee-assumptions-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 Employees API
CaptivateIQ Hierarchies API
CaptivateIQ Jobs API
CaptivateIQ Metadata API
CaptivateIQ Payouts API
CaptivateIQ Report Models API