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

The Hierarchies API from CaptivateIQ — 6 operation(s) for hierarchies.

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

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

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

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

9 operations 6 paths 17 schemas 1 DELETE4 GET3 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 Hierarchies 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 9

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

Hierarchies 9
GET
/ciq/v1/hierarchy-groups/
List Hierarchy Groups
hierarchy_groups_list 5 params → 200
POST
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/
Create Hierarchy
hierarchy_groups_hierarchies_create 1 param body → 201
GET
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/
List Hierarchies
hierarchy_groups_hierarchies_list 4 params → 200
POST
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/batch/
Batch Update Hierarchies
hierarchy_groups_hierarchies_batch_create 1 param body → 200
POST
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/import/
Bulk Import Hierarchies
hierarchy_groups_hierarchies_import_create 1 param body → 200
DELETE
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/{hierarchy_uuid}/
Delete Hierarchy
hierarchy_groups_hierarchies_destroy 2 params → 200
GET
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/{hierarchy_uuid}/
Get Hierarchy
hierarchy_groups_hierarchies_retrieve 2 params → 200
PUT
/ciq/v1/hierarchy-groups/{hierarchy_group_uuid}/hierarchies/{hierarchy_uuid}/
Update Hierarchy
hierarchy_groups_hierarchies_update 2 params body → 200
GET
/ciq/v1/hierarchy-groups/{id}/
Get Hierarchy Group
hierarchy_groups_retrieve 1 param → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Upload (13 properties), HierarchyUpdate (9 properties), Hierarchy (9 properties), HierarchyGroup (6 properties). Each schema is shown below with its type and property counts.

OpenAPIBatchResult
object
3 properties 3 required
HierarchyCreate
object
4 properties 2 required
HierarchyUpsert
object
5 properties 4 required
HierarchyUpdate
object
9 properties 4 required
DelimiterEnum
string
ImportModeEnum
string
DateFormatEnum
string
HierarchyGroup
object
6 properties 2 required
ImportParams
object
2 properties 2 required
OpenAPIDelete
object
3 properties
ObjectTypeEnum
string
BatchUpdateHierarchies
object
2 properties 2 required
ImportCSVRequest
object
5 properties 2 required
PaginatedHierarchyList
object
5 properties
Upload
object
13 properties 4 required
Hierarchy
object
9 properties 3 required
PaginatedHierarchyGroupList
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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