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

The Payouts API from CaptivateIQ — 8 operation(s) for payouts.

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

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

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

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

8 operations 8 paths 12 schemas 4 GET4 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 Payouts 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 8

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

Payouts 8
POST
/ciq/v1/payouts/adjustments/export/
Export Payout Adjustments
payouts_adjustments_export_create body → 200
POST
/ciq/v1/payouts/employee-assumptions/export/
Export Employee Assumptions
payouts_employee_assumptions_export_create body → 200
GET
/ciq/v1/payouts/payout-dates/
List Payout Dates
payouts_payout_dates_list 5 params → 200
POST
/ciq/v1/payouts/payout-summaries/export/
Export Payout Summaries
payouts_payout_summaries_export_create body → 200
GET
/ciq/v1/payouts/period-groups/
List Period Groups
payouts_period_groups_list 5 params → 200
GET
/ciq/v1/payouts/plans/
List Commission Plans
payouts_plans_list 5 params → 200
GET
/ciq/v1/payouts/worksheets/
List Worksheets
payouts_worksheets_list 6 params → 200
POST
/ciq/v1/payouts/worksheets/export/
Export Worksheet
payouts_worksheets_export_create body → 200

Schemas 12

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

Job
object
8 properties 1 required
PaginatedPeriodGroupPayoutList
object
5 properties
WorksheetSnapshotExportRequest
object
5 properties 2 required
PeriodGroupPayout
object
7 properties
Worksheet
object
2 properties
PaginatedPayoutDateList
object
5 properties
PayoutSnapshotExportRequest
object
4 properties 1 required
PlanPayout
object
8 properties
PaginatedWorksheetList
object
5 properties
JobMetadata
object
5 properties
PayoutDate
object
1 property
PaginatedPlanPayoutList
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-payouts-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 Report Models API