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 Commission Plans API

The Commission Plans API from CaptivateIQ — 5 operation(s) for commission plans.

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

Tagged areas include Commission Plans. 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 4 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 4 schemas 4 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 Commission Plans 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 — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Commission Plans 5
GET
/ciq/v1/period-groups/
List Period Groups
period_groups_list 6 params → 200
GET
/ciq/v1/period-groups/{id}/
Get Period Group
period_groups_retrieve 1 param → 200
GET
/ciq/v1/plans/
List Commission Plans
plans_list 6 params → 200
GET
/ciq/v1/plans/{id}/
Get Commission Plan
plans_retrieve 1 param → 200
POST
/ciq/v1/plans/{plan_uuid}/period-groups/{period_group_uuid}/employee-assumptions/export/
Export Employee Assumptions for Period Group
plans_period_groups_employee_assumptions_export_create 2 params → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Plan (11 properties), PeriodGroup (9 properties), PaginatedPlanList (5 properties), PaginatedPeriodGroupList (5 properties). Each schema is shown below with its type and property counts.

PaginatedPeriodGroupList
object
5 properties
PaginatedPlanList
object
5 properties
PeriodGroup
object
9 properties 2 required
Plan
object
11 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-commission-plans-api-openapi.yml Raw ↑

Other APIs CaptivateIQ publishes across the network.

CaptivateIQ Attribute Worksheets API
CaptivateIQ Audit Logs 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