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 Data Worksheets API

The Data Worksheets API from CaptivateIQ — 8 operation(s) for data worksheets.

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

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

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

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

11 operations 8 paths 16 schemas 1 DELETE5 GET4 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 Data Worksheets 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 11

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

Data Worksheets 11
GET
/ciq/v1/data-worksheets/
List Data Worksheets
data_worksheets_list 6 params → 200
GET
/ciq/v1/data-worksheets/{id}/
Get Data Worksheet
data_worksheets_retrieve 1 param → 200
POST
/ciq/v1/data-worksheets/{worksheet_uuid}/records/
Create Record
data_worksheets_records_create 1 param body → 201
GET
/ciq/v1/data-worksheets/{worksheet_uuid}/records/
List Records
data_worksheets_records_list 10 params → 200
POST
/ciq/v1/data-worksheets/{worksheet_uuid}/records/batch/
Batch Update Records
data_worksheets_records_batch_create 1 param body → 200
POST
/ciq/v1/data-worksheets/{worksheet_uuid}/records/export/
Bulk Export Records
data_worksheets_records_export_create 2 params → 200
POST
/ciq/v1/data-worksheets/{worksheet_uuid}/records/import/
Bulk Import Records
data_worksheets_records_import_create 1 param body → 200
GET
/ciq/v1/data-worksheets/{worksheet_uuid}/records/import/template/
Get Bulk Import Records Template
data_worksheets_records_import_template_retrieve 1 param → 200
DELETE
/ciq/v1/data-worksheets/{worksheet_uuid}/records/{unique_id}/
Delete Record
data_worksheets_records_destroy 2 params → 204
GET
/ciq/v1/data-worksheets/{worksheet_uuid}/records/{unique_id}/
Get Record
data_worksheets_records_retrieve 2 params → 200
PUT
/ciq/v1/data-worksheets/{worksheet_uuid}/records/{unique_id}/
Update Record
data_worksheets_records_update 2 params body → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Upload (13 properties), ColumnListItem (11 properties), DataWorksheet (10 properties), Job (8 properties). Each schema is shown below with its type and property counts.

BatchUpdateRecords
object
2 properties 2 required
Job
object
8 properties 1 required
DelimiterEnum
string
ImportModeEnum
string
PaginatedRecordList
object
5 properties
BatchResult
object
3 properties 3 required
DateFormatEnum
string
JobMetadata
object
5 properties
ObjectTypeEnum
string
DataWorksheet
object
10 properties 2 required
Record
object
5 properties 1 required
ColumnListItem
object
11 properties 5 required
DataWorksheetImportParams
object
3 properties 2 required
PaginatedDataWorksheetList
object
5 properties
Upload
object
13 properties 4 required
DataWorksheetImportCSVRequest
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-data-worksheets-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 Employee Assumptions API
CaptivateIQ Employees API
CaptivateIQ Hierarchies API
CaptivateIQ Jobs API
CaptivateIQ Metadata API
CaptivateIQ Payouts API
CaptivateIQ Report Models API