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

The Employees API from CaptivateIQ — 4 operation(s) for employees.

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

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

This API exposes 10 operations across 4 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.

10 operations 4 paths 12 schemas 2 DELETE4 GET2 POST2 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 Employees 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 10

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

Employees 10
POST
/ciq/v1/employee-visibilities/
Create Employee Visibility
employee_visibilities_create body → 201
GET
/ciq/v1/employee-visibilities/
List Employee Visibilities
employee_visibilities_list 7 params → 200
DELETE
/ciq/v1/employee-visibilities/{id}/
Delete Employee Visibility
employee_visibilities_destroy 1 param → 200
GET
/ciq/v1/employee-visibilities/{id}/
Get Employee Visibility
employee_visibilities_retrieve 1 param → 200
PUT
/ciq/v1/employee-visibilities/{id}/
Update Employee Visibility
employee_visibilities_update 1 param body → 200
POST
/ciq/v1/employees/
Create Employee
employees_create body → 201
GET
/ciq/v1/employees/
List Employees
employees_list 6 params → 200
DELETE
/ciq/v1/employees/{id}/
Delete Employee
employees_destroy 1 param → 204
GET
/ciq/v1/employees/{id}/
Get Employee
employees_retrieve 1 param → 200
PUT
/ciq/v1/employees/{id}/
Update Employee
employees_update 1 param body → 200

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are EmployeeOptionalUserSettings (12 properties), Employee (11 properties), EmployeeCreate (11 properties), EmployeeUpdate (10 properties). Each schema is shown below with its type and property counts.

NullEnum
EmployeeVisibility
object
9 properties 2 required
EmployeeUpdate
object
10 properties 6 required
PaginatedEmployeeVisibilityList
object
5 properties
EmployeeOptionalUserSettings
object
12 properties
Employee
object
11 properties 2 required
PaginatedEmployeeList
object
5 properties
EmployeeCreate
object
11 properties 1 required
OpenAPIDelete
object
3 properties
EmployeeVisibilityCreateUpdate
object
8 properties 2 required
LocaleEnum
string
BlankEnum

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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