CaptivateIQ
App · 25 actions
Work with your CaptivateIQ commissions: add and update employees, keep data worksheet records such as deals in step, update quotas, list plans, period groups and payout dates, and export payout summaries.
Actions
| Action | What it does |
|---|---|
| Add employee | Add an employee so they can be put on commission plans. |
| Add worksheet record | Add a record to a data worksheet, such as a closed deal, with a value for each column. |
| Delete employee | Delete an employee. |
| Delete worksheet record | Delete a record from a data worksheet by its unique ID. |
| Export payout summaries | Start exporting payout summaries (each payee's payout) for up to five payout dates as a CSV file. |
| Get data worksheet | Get one data worksheet with its columns and their data types. |
| Get employee | Get one employee with their email, status and final process date. |
| Get job | Check a CaptivateIQ job, such as an export, and get its download link once it has finished. |
| Get user | Get one user with their role, status and notification settings. |
| Get worksheet record | Get one record of a data worksheet by its unique ID. |
| List attribute worksheet records | List an attribute worksheet's records, each with the dates its values apply, searched or filtered by those dates. |
| List attribute worksheets | List attribute worksheets (values kept per employee or per plan over time, such as region or territory) with their columns. |
| List commission plans | List commission plans with their period groups and the dates payouts were processed for. |
| List data worksheets | List data worksheets (the tables commissions are calculated from, such as deals) with their columns. |
| List employee assumptions | List employee assumptions: which employee is on which plan and when, with their plan values such as quota. |
| List employees | List employees (the people paid commission), filtered by employee ID or name. |
| List organizations | List the CaptivateIQ organizations the connection's user belongs to. |
| List payout dates | List the dates payouts have been processed for, newest first. |
| List period groups | List period groups (a plan's stretch of time, such as FY2026) with their plan and dates. |
| List report models | List report models with their worksheets and period dates. |
| List users | List the people who can sign in to CaptivateIQ, with their role and notification settings, filtered by email or name. |
| List worksheet records | List a data worksheet's records, searched or filtered by when they were added or changed. |
| Update employee | Change an employee's ID, name, email, final process date or status. |
| Update employee assumption | Change an employee assumption's dates, payout currency or plan values, such as their quota. |
| Update worksheet record | Change some columns of a data worksheet record, found by its unique ID. |
Add employee
Add an employee so they can be put on commission plans. CaptivateIQ also makes a user for them unless you link an existing one. An active employee takes a seat.
Inputs
- Employee ID
employee_idtextRequired - Your organization's own ID for them, unique in CaptivateIQ, such as their HR system ID.
- Email
emailtext - Their email address. Needed unless an existing user is linked.
- First name
first_nametext - Their first name. Needed unless an existing user is linked.
- Last name
last_nametext - Their last name. Needed unless an existing user is linked.
- Existing user
linked_usertext - Link a user who already signs in to CaptivateIQ instead of making a new one.
- Final process date
final_process_datedate - The last date payouts are processed for them, such as their leaving date.
- Active
is_activetrue/false - Active employees count towards your seats.Default:
true. - Language
localetext - The language and number format they see. Defaults to your organization's.One of:
en_US(English (United States)),en_GB(English (United Kingdom)),en_AU(English (Australia)),en_CA(English (Canada)),en_SG(English (Singapore)),cs_CZ(Czech),de_DE(German),es_ES(Spanish (Spain)),es_US(Spanish (United States)),fr_CA(French (Canada)), and 11 more. - Can sign in
login_accesstrue/false - Let a new user for them sign in to CaptivateIQ.Default:
false. - Send welcome email
send_initial_emailtrue/false - Email a new user for them a welcome message.Default:
false.
Outputs
employeeobject- The employee
Example output
{
"employee": {
"additional_notification_emails": [],
"created_at": "2020-09-01T22:34:32.320468Z",
"email": "julie.wise@captivateiq.com",
"employee_id": "User106",
"final_process_date": null,
"first_name": "Julie",
"id": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
"is_active": true,
"last_name": "Wise",
"linked_user": "da6275af-4648-4d76-964e-7faf2c35276b",
"object": "employee",
"updated_at": "2020-09-09T21:30:26.662966Z"
}
}Add worksheet record
Add a record to a data worksheet, such as a closed deal, with a value for each column. Include the worksheet's unique ID column.
Inputs
- Data worksheet
worksheet_idtextRequired - The data worksheet. Pick one, or give its ID.
- Columns
dataobjectRequired - A value for each column to set, by column name. Columns left empty aren't changed.
Outputs
recordobject- The record
Example output
{
"record": {
"created_at": "2021-11-12T20:56:52.084975Z",
"data": {
"Amount": "40000",
"Closed Won Date": "2021-11-01",
"Opportunity ID": "OPP-1042"
},
"id": "3b9f0e57-8d2c-4a71-b6e4-0c5d9a8f7e61",
"object": "record",
"updated_at": "2021-11-12T23:14:49.501564Z"
}
}Delete employee
Delete an employee. To stop paying someone but keep their record, make them inactive or give them a final process date with 'Update employee' instead.
Inputs
- Employee
employeetextRequired - The employee. Pick one, or give CaptivateIQ's ID for them.
Outputs
deletedtrue/false- Always true once deleted
employeetext- The ID of the employee deleted
Example output
{
"deleted": true,
"employee": "f386ae72-ec52-4b16-b9f2-dbb98b93189e"
}Delete worksheet record
Delete a record from a data worksheet by its unique ID.
Inputs
- Data worksheet
worksheet_idtextRequired - The data worksheet. Pick one, or give its ID.
- Record's unique ID
unique_idtextRequired - The record's value in the worksheet's unique ID column, such as a deal or invoice number.
Outputs
deletedtrue/false- Always true once deleted
unique_idtext- The unique ID of the record deleted
Example output
{
"deleted": true,
"unique_id": "OPP-1042"
}Export payout summaries
Start exporting payout summaries (each payee's payout) for up to five payout dates as a CSV file. Use 'Get job' with the job's ID to get the download link once it's done.
Inputs
- Payout dates
payout_dateslistRequired - One to five dates payouts were processed for.
- Commission plans
planslist - Only these commission plans. Leave empty for every plan.
- Period groups
period_groupslist - Only these period groups. Leave empty for every period group.
- Locked payouts only
locked_onlytrue/false - Export only payouts that have been locked.Default:
false.
Outputs
jobobject- The export job
Example output
{
"job": {
"description": "Export payout summary for dates 2019-03-31",
"details": {},
"id": "4395edba-32b0-4b35-a9a9-6046ce35742a",
"metadata": {
"aggregation_id": "752213c1-d282-478d-b361-b56db36d6dca",
"created_at": "2021-11-12T21:56:58.266015Z",
"updated_at": "2021-11-12T21:56:58.266039Z",
"user_email": "testuser@example.com",
"user_id": "17ef55f6-b592-4d59-8df0-3420363e20b6"
},
"object": "job",
"status": "PENDING",
"type": "Export Payout Summary (API)",
"url": "/ciq/v1/jobs/4395edba-32b0-4b35-a9a9-6046ce35742a/"
}
}Get data worksheet
Get one data worksheet with its columns and their data types.
Inputs
- Data worksheet
worksheet_idtextRequired - The data worksheet. Pick one, or give its ID.
Outputs
worksheetobject- The data worksheet
Example output
{
"worksheet": {
"columns": [
{
"created_at": "2021-11-12T20:56:52.084975Z",
"data_type": "string",
"description": "",
"format": null,
"formula": null,
"id": "5a0e8f43-2c4b-4bb5-8f9e-3c2d7d0b1a21",
"name": "Opportunity ID",
"object": "column",
"read_only": false,
"updated_at": "2021-11-12T20:56:52.084975Z",
"variant": "raw"
}
],
"created_at": "2021-11-12T20:56:52.084975Z",
"description": "Closed won deals from the CRM",
"id": "7c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"name": "Deal Data",
"object": "data_worksheet",
"type": "raw",
"updated_at": "2021-11-12T23:14:49.501564Z",
"workbook": "1e2d3c4b-5a69-4788-9a0b-1c2d3e4f5a6b",
"workbook_name": "Sales Data"
}
}Get employee
Get one employee with their email, status and final process date.
Inputs
- Employee
employeetextRequired - The employee. Pick one, or give CaptivateIQ's ID for them.
Outputs
employeeobject- The employee
Example output
{
"employee": {
"additional_notification_emails": [],
"created_at": "2020-09-01T22:34:32.320468Z",
"email": "julie.wise@captivateiq.com",
"employee_id": "User106",
"final_process_date": null,
"first_name": "Julie",
"id": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
"is_active": true,
"last_name": "Wise",
"linked_user": "da6275af-4648-4d76-964e-7faf2c35276b",
"object": "employee",
"updated_at": "2020-09-09T21:30:26.662966Z"
}
}Get job
Check a CaptivateIQ job, such as an export, and get its download link once it has finished.
Inputs
- Job ID
job_idtextRequired - The job's ID, from 'Export payout summaries'.
Outputs
download_urltext- The export's download link, empty until it succeeds
is_finishedtrue/false- Whether the job has stopped (succeeded or failed)
jobobject- The job
succeededtrue/false- Whether the job succeeded
Example output
{
"download_url": "https://captivateiq-downloads.s3.amazonaws.com/downloads/example.csv",
"is_finished": true,
"job": {
"description": "Export payout summary for dates 2019-03-31",
"details": {
"download_id": "149b20b6-2725-42f3-ad87-e4b2596e3283",
"download_url": "https://captivateiq-downloads.s3.amazonaws.com/downloads/example.csv"
},
"id": "4395edba-32b0-4b35-a9a9-6046ce35742a",
"metadata": {
"aggregation_id": "752213c1-d282-478d-b361-b56db36d6dca",
"created_at": "2021-11-12T21:56:58.266015Z",
"updated_at": "2021-11-12T21:56:58.266039Z",
"user_email": "testuser@example.com",
"user_id": "17ef55f6-b592-4d59-8df0-3420363e20b6"
},
"object": "job",
"status": "SUCCESS",
"type": "Export Payout Summary (API)",
"url": "/ciq/v1/jobs/4395edba-32b0-4b35-a9a9-6046ce35742a/"
},
"succeeded": true
}Get user
Get one user with their role, status and notification settings.
Inputs
- User
ciq_usertextRequired - The user. Pick one, or give CaptivateIQ's ID for them.
Outputs
userobject- The user
Example output
{
"user": {
"created_at": "2020-09-01T22:34:32.320468Z",
"eligible_to_receive_inquiries": true,
"eligible_to_submit_inquiries": true,
"email": "julie.wise@captivateiq.com",
"enable_audit_log_export_notifications": false,
"enable_connector_sync_email_notifications": true,
"enable_inquiry_notifications": false,
"enable_payout_processing_notifications": false,
"enable_scim_email_notifications": false,
"enable_statement_notifications": true,
"first_name": "Julie",
"id": "da6275af-4648-4d76-964e-7faf2c35276b",
"is_active": true,
"is_organization_admin": false,
"last_activity": "2026-10-14T16:02:11.000000Z",
"last_name": "Wise",
"linked_employee": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
"locale": "en_US",
"login_id": null,
"object": "user",
"role": "Payee",
"timezone": "America/Los_Angeles",
"updated_at": "2020-09-09T21:30:26.662966Z"
}
}Get worksheet record
Get one record of a data worksheet by its unique ID.
Inputs
- Data worksheet
worksheet_idtextRequired - The data worksheet. Pick one, or give its ID.
- Record's unique ID
unique_idtextRequired - The record's value in the worksheet's unique ID column, such as a deal or invoice number.
Outputs
recordobject- The record
Example output
{
"record": {
"created_at": "2021-11-12T20:56:52.084975Z",
"data": {
"Amount": "40000",
"Closed Won Date": "2021-11-01",
"Opportunity ID": "OPP-1042"
},
"id": "3b9f0e57-8d2c-4a71-b6e4-0c5d9a8f7e61",
"object": "record",
"updated_at": "2021-11-12T23:14:49.501564Z"
}
}List attribute worksheet records
List an attribute worksheet's records, each with the dates its values apply, searched or filtered by those dates.
Inputs
- Attribute worksheet
attribute_worksheet_idtextRequired - The attribute worksheet. Pick one, or give its ID.
- Search
querytext - Only records with this text in any column (not case sensitive).
- Starting on or after
start_afterdate - Only those starting on or after this date.
- Starting on or before
start_beforedate - Only those starting on or before this date.
- Ending on or after
end_afterdate - Only those ending on or after this date.
- Ending on or before
end_beforedate - Only those ending on or before this date.
- Page size
limitnumber - How many records to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
recordslist- The records
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"records": [
{
"data": {
"Employee ID": "Employee001",
"Region": "West"
},
"end_date": "2021-11-30",
"id": "4c5d6e7f-8091-4a2b-b3c4-d5e6f7081920",
"object": "attribute_record",
"start_date": "2021-11-01"
}
],
"total_count": 1
}List attribute worksheets
List attribute worksheets (values kept per employee or per plan over time, such as region or territory) with their columns.
Inputs
- Name contains
name_containstext - Only worksheets whose name has this text (not case sensitive).
- Kept per
key_typetext - Only worksheets keyed this way. Leave empty for all.One of:
employee(Keyed by employee),plan_period_group(Keyed by plan and period group),custom(Custom key). - Period group
period_grouptext - Only worksheets for this period group.
- Page size
limitnumber - How many worksheets to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
total_countnumber- How many there are in all
worksheetslist- The attribute worksheets
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"total_count": 1,
"worksheets": [
{
"columns": [
{
"data_type": "string",
"description": null,
"id": "2b3c4d5e-6f70-4812-9a3b-4c5d6e7f8091",
"is_primary_key": false,
"name": "Region",
"object": "column",
"read_only": false,
"variant": "raw"
}
],
"created_at": "2021-11-12T20:56:52.084975Z",
"description": null,
"id": "9f8e7d6c-5b4a-4392-8170-6f5e4d3c2b1a",
"is_hidden": false,
"name": "Employee Attributes",
"object": "attribute_worksheet",
"pk_column_uuids": [
"8a7b6c5d-4e3f-4210-9b8a-7c6d5e4f3a2b"
],
"pk_type": "employee",
"type": "attribute",
"updated_at": "2021-11-12T23:14:49.501564Z",
"workbook": "1e2d3c4b-5a69-4788-9a0b-1c2d3e4f5a6b"
}
]
}List commission plans
List commission plans with their period groups and the dates payouts were processed for.
Inputs
- Status
statustext - Only active, or only inactive. Leave empty for both.One of:
active(Active only),inactive(Inactive only). - Period groups
period_groupslist - Only these period groups. Leave empty for every period group.
- Order
orderingtext - How to sort them. Defaults to name, A to Z.One of:
name(Name, A to Z (default)),-name(Name, Z to A),-created_at(Newest first),-updated_at(Most recently changed first). - Page size
limitnumber - How many plans to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
planslist- The commission plans
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"plans": [
{
"confetti_enabled": true,
"created_at": "2019-01-04T18:22:10.000000Z",
"id": "92d06596-84c5-4687-adc9-5ce0034e14c7",
"is_active": true,
"name": "First AE Plan",
"object": "plan",
"payout_dates": [
"2019-03-31"
],
"period_groups": [
{
"id": "ef6b2a2f-5936-49b3-bafd-6225dc2fc5cd"
}
],
"updated_at": "2019-04-02T09:12:44.000000Z"
}
],
"total_count": 1
}List data worksheets
List data worksheets (the tables commissions are calculated from, such as deals) with their columns.
Inputs
- Data workbooks
workbookslist - Only worksheets in these workbooks. Leave empty for every workbook.
- Name contains
name_containstext - Only worksheets whose name has this text (not case sensitive).
- Type
worksheet_typetext - Only raw or only derived worksheets. Leave empty for both.One of:
raw(Raw (data you load)),derived(Derived (calculated)). - Page size
limitnumber - How many worksheets to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
total_countnumber- How many there are in all
worksheetslist- The data worksheets
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"total_count": 1,
"worksheets": [
{
"columns": [
{
"created_at": "2021-11-12T20:56:52.084975Z",
"data_type": "string",
"description": "",
"format": null,
"formula": null,
"id": "5a0e8f43-2c4b-4bb5-8f9e-3c2d7d0b1a21",
"name": "Opportunity ID",
"object": "column",
"read_only": false,
"updated_at": "2021-11-12T20:56:52.084975Z",
"variant": "raw"
}
],
"created_at": "2021-11-12T20:56:52.084975Z",
"description": "Closed won deals from the CRM",
"id": "7c1d2e3f-4a5b-4c6d-8e7f-9a0b1c2d3e4f",
"name": "Deal Data",
"object": "data_worksheet",
"type": "raw",
"updated_at": "2021-11-12T23:14:49.501564Z",
"workbook": "1e2d3c4b-5a69-4788-9a0b-1c2d3e4f5a6b",
"workbook_name": "Sales Data"
}
]
}List employee assumptions
List employee assumptions: which employee is on which plan and when, with their plan values such as quota.
Inputs
- Employee
employee_idtext - Only this employee, by your organization's own employee ID.
- Commission plans
planslist - Only these commission plans. Leave empty for every plan.
- Period groups
period_groupslist - Only these period groups. Leave empty for every period group.
- Starting on or after
start_afterdate - Only those starting on or after this date.
- Starting on or before
start_beforedate - Only those starting on or before this date.
- Ending on or after
end_afterdate - Only those ending on or after this date.
- Ending on or before
end_beforedate - Only those ending on or before this date.
- Search
querytext - Only those whose summary (name, ID and dates) has this text.
- Page size
limitnumber - How many employee assumptions to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
assumptionslist- The employee assumptions
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
total_countnumber- How many there are in all
Example output
{
"assumptions": [
{
"data": {
"Quota": "40000"
},
"display_value": "Jason Atlanta (Employee001) | 11/1/21 to 11/30/21",
"eid": "Employee001",
"employee": "8604da2c-1aab-43eb-b872-4f27d350419b",
"end_date": "2021-11-30",
"hierarchy_group_override": null,
"id": "60a9e3bb-4e26-4606-a199-947f08675d24",
"object": "employee_assumption",
"payout_currency": "USD",
"period_group": "ba77edc0-f710-4555-9040-f2c75f8746a6",
"start_date": "2021-11-01",
"statement_template": null,
"updated_at": "2021-11-12T23:14:49.501564Z"
}
],
"count": 1,
"has_more": false,
"next_offset": 1,
"total_count": 1
}List employees
List employees (the people paid commission), filtered by employee ID or name. Gets one page; to see more, run it again starting at the next offset it gives.
Inputs
- Employee ID
employee_idtext - Only the employee with this ID of your organization's own.
- First name
first_nametext - Only employees with this first name.
- Last name
last_nametext - Only employees with this last name.
- Order
orderingtext - How to sort them. Defaults to employee ID, A to Z.One of:
employee_id(Employee ID, A to Z (default)),-employee_id(Employee ID, Z to A),first_name(First name, A to Z),-first_name(First name, Z to A),last_name(Last name, A to Z),-last_name(Last name, Z to A). - Page size
limitnumber - How many employees to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
employeeslist- The employees
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
total_countnumber- How many there are in all
Example output
{
"count": 1,
"employees": [
{
"additional_notification_emails": [],
"created_at": "2020-09-01T22:34:32.320468Z",
"email": "julie.wise@captivateiq.com",
"employee_id": "User106",
"final_process_date": null,
"first_name": "Julie",
"id": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
"is_active": true,
"last_name": "Wise",
"linked_user": "da6275af-4648-4d76-964e-7faf2c35276b",
"object": "employee",
"updated_at": "2020-09-09T21:30:26.662966Z"
}
],
"has_more": false,
"next_offset": 1,
"total_count": 1
}List organizations
List the CaptivateIQ organizations the connection's user belongs to.
Inputs
- Page size
limitnumber - How many organizations to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
organizationslist- The organizations
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"organizations": [
{
"created_at": "2020-09-01T22:30:00.000000Z",
"id": "0b6f6f1e-3d1a-4e7e-9a55-2f6c1b7e4a10",
"name": "Acme Inc.",
"object": "organization",
"updated_at": "2026-10-02T07:32:12.811000Z"
}
],
"total_count": 1
}List payout dates
List the dates payouts have been processed for, newest first.
Inputs
- Commission plans
planslist - Only these commission plans. Leave empty for every plan.
- Period groups
period_groupslist - Only these period groups. Leave empty for every period group.
- Page size
limitnumber - How many dates to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
payout_dateslist- The payout dates
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"payout_dates": [
{
"payout_date": "2019-03-31"
}
],
"total_count": 1
}List period groups
List period groups (a plan's stretch of time, such as FY2026) with their plan and dates.
Inputs
- Commission plans
planslist - Only these commission plans. Leave empty for every plan.
- Status
statustext - Only active, or only inactive. Leave empty for both.One of:
active(Active only),inactive(Inactive only). - Page size
limitnumber - How many period groups to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
period_groupslist- The period groups
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"period_groups": [
{
"created_at": "2019-01-04T18:22:10.000000Z",
"end_date": "2019-12-31",
"id": "ef6b2a2f-5936-49b3-bafd-6225dc2fc5cd",
"is_active": true,
"name": "FY2019",
"object": "period_group",
"plan": "92d06596-84c5-4687-adc9-5ce0034e14c7",
"plan_name": "First AE Plan",
"start_date": "2019-01-01",
"updated_at": "2019-04-02T09:12:44.000000Z",
"workbook": "6d5c4b3a-2918-4706-a5b4-c3d2e1f0a9b8"
}
],
"total_count": 1
}List report models
List report models with their worksheets and period dates.
Inputs
- Name
nametext - Only the report model with this name.
- Type
model_typetext - Time series or visualization. Defaults to time series.One of:
time_series(Time series (default)),visualization. - Period date
period_datedate - Only models with a period on this date.
- Page size
limitnumber - How many report models to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
report_modelslist- The report models
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"report_models": [
{
"description": "Attainment by rep and quarter",
"id": "0f1e2d3c-4b5a-4697-8877-665544332211",
"name": "Quarterly attainment",
"object": "report_model",
"period_dates": [
{
"date": "2026-09-30",
"id": "2b3c4d5e-6f70-4891-9abc-def123456789",
"object": "period_date"
}
],
"type": "time_series",
"worksheets": [
{
"id": "1a2b3c4d-5e6f-4789-8abc-def012345678",
"is_hidden": false,
"name": "Attainment",
"object": "worksheet",
"type": "output"
}
]
}
],
"total_count": 1
}List users
List the people who can sign in to CaptivateIQ, with their role and notification settings, filtered by email or name.
Inputs
- Email
emailtext - Only the user with this email address.
- First name
first_nametext - Only users with this first name.
- Last name
last_nametext - Only users with this last name.
- Order
orderingtext - How to sort them. Defaults to oldest first.One of:
created_at(Oldest first (default)),-created_at(Newest first),email(Email, A to Z),-email(Email, Z to A),first_name(First name, A to Z),last_name(Last name, A to Z). - Page size
limitnumber - How many users to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
total_countnumber- How many there are in all
userslist- The users
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"total_count": 1,
"users": [
{
"created_at": "2020-09-01T22:34:32.320468Z",
"eligible_to_receive_inquiries": true,
"eligible_to_submit_inquiries": true,
"email": "julie.wise@captivateiq.com",
"enable_audit_log_export_notifications": false,
"enable_connector_sync_email_notifications": true,
"enable_inquiry_notifications": false,
"enable_payout_processing_notifications": false,
"enable_scim_email_notifications": false,
"enable_statement_notifications": true,
"first_name": "Julie",
"id": "da6275af-4648-4d76-964e-7faf2c35276b",
"is_active": true,
"is_organization_admin": false,
"last_activity": "2026-10-14T16:02:11.000000Z",
"last_name": "Wise",
"linked_employee": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
"locale": "en_US",
"login_id": null,
"object": "user",
"role": "Payee",
"timezone": "America/Los_Angeles",
"updated_at": "2020-09-09T21:30:26.662966Z"
}
]
}List worksheet records
List a data worksheet's records, searched or filtered by when they were added or changed. Shows the values loaded into the worksheet, not calculated columns.
Inputs
- Data worksheet
worksheet_idtextRequired - The data worksheet. Pick one, or give its ID.
- Search
querytext - Only records with this text in any column (not case sensitive).
- Search in column
query_columntext - Search only this column, by name. Leave empty to search them all.
- Added on or after
created_afterdate - Only records added on or after this date.
- Added before
created_beforedate - Only records added before this date.
- Changed on or after
updated_afterdate - Only records changed on or after this date.
- Changed before
updated_beforedate - Only records changed before this date.
- Order
orderingtext - How to sort them. Defaults to oldest first.One of:
created_at(Oldest first (default)),-created_at(Newest first),updated_at(Least recently changed first),-updated_at(Most recently changed first). - Page size
limitnumber - How many records to return, 1 to 100.From 1 to 100.
- Start at
offsetnumber - How many to skip, for the next page: the 'next_offset' an earlier page gave. Leave empty for the first page.At least 0.
Outputs
countnumber- How many are on this page
has_moretrue/false- Whether another page follows
next_offsetnumber- The offset to ask for to get the next page
recordslist- The records
total_countnumber- How many there are in all
Example output
{
"count": 1,
"has_more": false,
"next_offset": 1,
"records": [
{
"created_at": "2021-11-12T20:56:52.084975Z",
"data": {
"Amount": "40000",
"Closed Won Date": "2021-11-01",
"Opportunity ID": "OPP-1042"
},
"id": "3b9f0e57-8d2c-4a71-b6e4-0c5d9a8f7e61",
"object": "record",
"updated_at": "2021-11-12T23:14:49.501564Z"
}
],
"total_count": 1
}Update employee
Change an employee's ID, name, email, final process date or status. Only the fields given change.
Inputs
- Employee
employeetextRequired - The employee. Pick one, or give CaptivateIQ's ID for them.
- New employee ID
employee_idtext - A new ID of your organization's own. Leave empty to keep it.
- Email
emailtext - A new email address. Leave empty to keep it.
- First name
first_nametext - A new first name. Leave empty to keep it.
- Last name
last_nametext - A new last name. Leave empty to keep it.
- Final process date
final_process_datedate - The last date payouts are processed for them, such as their leaving date.
- Status
statustext - Make them active (takes a seat) or inactive. Leave empty to keep it.One of:
active,inactive.
Outputs
employeeobject- The employee
Example output
{
"employee": {
"additional_notification_emails": [],
"created_at": "2020-09-01T22:34:32.320468Z",
"email": "julie.wise@captivateiq.com",
"employee_id": "User106",
"final_process_date": null,
"first_name": "Julie",
"id": "f386ae72-ec52-4b16-b9f2-dbb98b93189e",
"is_active": false,
"last_name": "Wise",
"linked_user": "da6275af-4648-4d76-964e-7faf2c35276b",
"object": "employee",
"updated_at": "2020-09-09T21:30:26.662966Z"
}
}Update employee assumption
Change an employee assumption's dates, payout currency or plan values, such as their quota. Only what you give changes.
Inputs
- Employee assumption ID
assumption_idtextRequired - The employee assumption's ID, from 'List employee assumptions'.
- Start date
start_datedate - A new first day. Leave empty to keep it.
- End date
end_datedate - A new last day. Leave empty to keep it.
- Payout currency
payout_currencytext - A new payout currency. Leave empty to keep it.One of:
USD(US dollar (USD)),EUR(Euro (EUR)),GBP(British pound (GBP)),CAD(Canadian dollar (CAD)),AUD(Australian dollar (AUD)),JPY(Japanese yen (JPY)),INR(Indian rupee (INR)),CHF(Swiss franc (CHF)),SGD(Singapore dollar (SGD)),NZD(New Zealand dollar (NZD)), and 10 more. - Plan values
dataobject - Values to set by column name, such as Quota. Columns not given keep their values.
Outputs
assumptionobject- The employee assumption
Example output
{
"assumption": {
"data": {
"Quota": "50000"
},
"display_value": "Jason Atlanta (Employee001) | 11/1/21 to 11/30/21",
"eid": "Employee001",
"employee": "8604da2c-1aab-43eb-b872-4f27d350419b",
"end_date": "2021-11-30",
"hierarchy_group_override": null,
"id": "60a9e3bb-4e26-4606-a199-947f08675d24",
"object": "employee_assumption",
"payout_currency": "USD",
"period_group": "ba77edc0-f710-4555-9040-f2c75f8746a6",
"start_date": "2021-11-01",
"statement_template": null,
"updated_at": "2021-11-12T23:14:49.501564Z"
}
}Update worksheet record
Change some columns of a data worksheet record, found by its unique ID. Columns not given keep their values.
Inputs
- Data worksheet
worksheet_idtextRequired - The data worksheet. Pick one, or give its ID.
- Record's unique ID
unique_idtextRequired - The record's value in the worksheet's unique ID column, such as a deal or invoice number.
- Columns
dataobjectRequired - A value for each column to set, by column name. Columns left empty aren't changed.
Outputs
recordobject- The record
Example output
{
"record": {
"created_at": "2021-11-12T20:56:52.084975Z",
"data": {
"Amount": "45000",
"Closed Won Date": "2021-11-01",
"Opportunity ID": "OPP-1042"
},
"id": "3b9f0e57-8d2c-4a71-b6e4-0c5d9a8f7e61",
"object": "record",
"updated_at": "2021-11-12T23:14:49.501564Z"
}
}