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

The Users API from CaptivateIQ — 2 operation(s) for users.

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

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

This API exposes 5 operations across 2 paths, and defines 7 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 2 paths 7 schemas 1 DELETE2 GET1 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 Users 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 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 5
POST
/ciq/v1/users/
Create User
users_create body → 201
GET
/ciq/v1/users/
List Users
users_list 6 params → 200
DELETE
/ciq/v1/users/{id}/
Delete User
users_destroy 1 param → 204
GET
/ciq/v1/users/{id}/
Get User
users_retrieve 1 param → 200
PUT
/ciq/v1/users/{id}/
Update User
users_update 1 param body → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are User (23 properties), UserCreate (20 properties), UserUpdate (14 properties), PaginatedUserList (5 properties). Each schema is shown below with its type and property counts.

NullEnum
UserUpdate
object
14 properties 9 required
User
object
23 properties 3 required
LocaleEnum
string
PaginatedUserList
object
5 properties
UserCreate
object
20 properties 3 required
BlankEnum

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

captivateiq-users-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