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

The Uploads API from CaptivateIQ — 3 operation(s) for uploads.

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

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

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

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

3 operations 3 paths 9 schemas 2 GET1 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 Uploads 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 3

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

Uploads 3
GET
/ciq/v1/uploads/
List Uploads
uploads_list 3 params → 200
GET
/ciq/v1/uploads/{id}/
Get Upload
uploads_retrieve 1 param → 200
POST
/ciq/v1/uploads/{id}/process/
Process Upload
uploads_process_create 1 param body → 200

Schemas 9

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

Job
object
8 properties 1 required
DelimiterEnum
string
UploadOverrides
object
4 properties
ProcessUploadRequest
object
1 property
DateFormatEnum
string
PaginatedUploadList
object
5 properties
JobMetadata
object
5 properties
ObjectTypeEnum
string
Upload
object
13 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-uploads-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 Jobs API
CaptivateIQ Metadata API
CaptivateIQ Payouts API