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

The Attribute Worksheets API from CaptivateIQ — 5 operation(s) for attribute worksheets.

CaptivateIQ Attribute 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 Attribute Worksheets. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

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

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

5 operations 5 paths 19 schemas 3 GET2 POST

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 Attribute 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 5

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

Attribute Worksheets 5
GET
/ciq/v1/attribute-worksheets/
List Attribute Worksheets
attribute_worksheets_list 5 params → 200
GET
/ciq/v1/attribute-worksheets/{worksheet_uuid}/columns/{column_uuid}/custom-picklist-options/
List Custom Picklist Options
attribute_worksheets_columns_custom_picklist_options_list 4 params → 200
POST
/ciq/v1/attribute-worksheets/{worksheet_uuid}/columns/{column_uuid}/custom_picklist_options/import/
Bulk Import Custom Picklist Options
attribute_worksheets_columns_custom_picklist_options_import_create 2 params body → 200
GET
/ciq/v1/attribute-worksheets/{worksheet_uuid}/records/
List Records
attribute_worksheets_records_list 8 params → 200
POST
/ciq/v1/attribute-worksheets/{worksheet_uuid}/records/batch/
Batch Update Records
attribute_worksheets_records_batch_create 1 param body → 200

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Column (21 properties), AttributeWorksheet (14 properties), Upload (13 properties), ImportCSVRequest (5 properties). Each schema is shown below with its type and property counts.

DelimiterEnum
string
TypeEnum
string
PaginatedAttributeWorksheetList
object
5 properties
AttributeRecord
object
5 properties 2 required
PicklistOption
object
3 properties 2 required
ImportParams
object
2 properties 2 required
ImportCSVRequest
object
5 properties 2 required
PaginatedAttributeRecordList
object
5 properties
Column
object
21 properties 6 required
BulkAttributeRecordsByColumnName
object
2 properties 2 required
ImportModeEnum
string
PaginatedPickListOptionsResponseList
object
5 properties
DateFormatEnum
string
ObjectTypeEnum
string
DataTypeEnum
string
PickListOptionsResponse
object
4 properties 2 required
BatchUpdateRecordsByColumnNameResponse
object
3 properties 3 required
AttributeWorksheet
object
14 properties 1 required
Upload
object
13 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-attribute-worksheets-api-openapi.yml Raw ↑

Other APIs CaptivateIQ publishes across the network.

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 Jobs API
CaptivateIQ Metadata API
CaptivateIQ Payouts API
CaptivateIQ Report Models API