Articles in this section

Available CaptivateIQ APIs

When you configure an export, import, or other type of flow step using the prebuilt CaptivateIQ connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the CaptivateIQ API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource

API endpoint

Export

Import

Attribute worksheets

List attribute worksheets

X

List custom picklist options

X

Bulk import custom picklist options

X

List records

X

Batch update records

X

Audit logs

List audit logs

X

Commission plans

List period groups

X

Get period group

X

List commission plans

X

Get commission plan

X

Export employee assumptions for period group

X

Dashboards

List users with access

X

Share dashboard

X

Unshare dashboard

X

List published dashboards

X

Data workbooks

List data workbooks

X

Get data workbook

X

Data worksheets

List data worksheets

X

Get data worksheet

X

List records

X

Create record

X

Get record

X

Update record

X

Delete record

X

Batch update records

X

Bulk export records

X

Bulk import records

X

Get bulk import records template

X

Employee assumptions

List employee assumptions

X

Create employee assumption

X

Get employee assumption

X

Update employee assumption

X

Delete employee assumption

X

Batch update employee assumptions

X

Employees

List employee visibilities

X

Create employee visibility

X

Get employee visibility

X

Update employee visibility

X

Delete employee visibility

X

List employees

X

Create employee

X

Get employee

X

Update employee

X

Delete employee

X

Hierarchies

List hierarchy groups

X

List hierarchies

X

Create hierarchy

X

Get hierarchy

X

Update hierarchy

X

Delete hierarchy

X

Batch update hierarchies

X

Bulk import hierarchies

X

Get hierarchy group

X

Jobs

List job aggregation

X

Get job aggregation

X

List jobs

X

Get job

X

Metadata

List organizations

X

Payouts

Export payout adjustments

X

Export employee assumptions

X

List payout dates

X

Export payout summaries

X

List period groups

X

List commission plans (Payouts)

X

List worksheets

X

Export worksheet

X

Report models

List report models

X

Export report model worksheet

X

List report models exports

X

Retrieve report model

X

Export report model worksheet records

X

Transformation worksheets

List transformation worksheets

X

Get transformation worksheet

X

Bulk export records

X

Uploads

List uploads

X

Get upload

X

Process upload

X

Users

List users

X

Create user

X

Get user

X

Update user

X

Delete user

X