Skip to main content
Iterate logo
  • Category: forms & surveys
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 13
  • Triggers: 0
  • Slug: ITERATE
  • Version: 20261101_00

Tools

Slug: ITERATE_ADD_SURVEY_RECIPIENTAdd one email recipient to a survey for a later send without sending the survey now.

Input Parameters

string
required
Recipient email address.
string
Recipient last name.
string
required
Survey ID to receive the recipient.
string
Recipient first name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_ANONYMIZE_COMPANY_USERIrreversibly remove one Iterate user’s email and attributes while retaining survey responses. Optionally also remove response properties. Requires an exact user ID and explicit confirm_anonymization=true.

Input Parameters

string
required
Exact Iterate user ID to anonymize, normally returned by Search Company Users.
boolean
required
Must be the boolean value true to confirm irreversible removal of this user’s identifying data. This confirmation is validated locally and is never sent to Iterate.
boolean
Also irreversibly remove properties stored on the user’s responses; defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_BULK_ANONYMIZE_COMPANY_USERSIrreversibly anonymize Iterate company users selected by email, external ID, or typed user properties while retaining survey responses, optionally removing response properties as well. Requires explicit confirmation and returns anonymized and failed counts.

Input Parameters

array
One or more email addresses selecting users to anonymize.
array
One or more external user IDs selecting users to anonymize.
array
One or more typed user-property matches selecting users to anonymize.
boolean
required
Must be the boolean value true to confirm irreversible anonymization of every user matched by these selectors. This confirmation is validated locally and is never sent to Iterate.
boolean
Also irreversibly remove properties stored on matching users’ responses; defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_BULK_DELETE_COMPANY_USER_DATAPermanently delete selected Iterate company users and their survey responses using explicit non-empty selectors. This cannot be undone, requires confirmation, and returns deleted and failed counts.

Input Parameters

array
Email addresses selecting users and responses for permanent deletion.
array
External user IDs selecting users and responses for permanent deletion.
array
Typed user-property matches selecting users and responses for deletion.
boolean
required
Must be the boolean value true to confirm permanent deletion of every matched user and survey response. It is validated locally and never sent to Iterate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_DELETE_COMPANY_USER_DATAPermanently delete one Iterate user object and all of that user’s survey responses. This cannot be undone and requires an exact user ID plus explicit confirm_permanent_deletion=true.

Input Parameters

string
required
Exact Iterate user ID whose object and responses will be permanently deleted, normally returned by Search Company Users.
boolean
required
Must be the boolean value true to confirm permanent deletion of this user and every associated survey response. This confirmation is validated locally and is never sent to Iterate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_GET_SURVEYReturn one survey’s configuration and questions by survey ID. The action fails when Iterate embeds an error in an HTTP 200 response.

Input Parameters

string
required
Survey ID returned by List Surveys.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_GET_SURVEY_STATSReturn delivery, display, response-count, and response-rate statistics for one survey.

Input Parameters

string
required
Survey ID whose aggregate statistics to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_IMPORT_SURVEY_RECIPIENTSAdd a non-empty batch of email recipients to a survey without sending it, and return duplicate, failure, and success counts.

Input Parameters

string
required
Survey ID to receive the imported recipients.
array
required
One or more recipients to add. Each recipient requires an email address and may include a first and last name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_LIST_SURVEY_RESPONSE_GROUPSReturn one reverse-chronological page of completed survey submissions grouped by user, plus a continuation cursor.

Input Parameters

string
Continuation URL returned as next_cursor by the previous call; omit for the first page and pass it back unchanged.
string
required
Survey ID whose completed user-grouped submissions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_LIST_SURVEY_RESPONSESReturn one reverse-chronological page of individual answers for a survey, with an optional date range and continuation cursor.

Input Parameters

string
Continuation cursor returned as next_cursor by the previous call; omit for the first page and pass it back unchanged.
number
Optional inclusive upper bound as a Unix timestamp.
string
required
Survey ID whose individual responses to list.
number
Optional inclusive lower bound as a Unix timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_LIST_SURVEYSList surveys available to the connected Iterate API key, including survey IDs and company IDs when returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_SEARCH_COMPANY_USERSFind one user in the connected Iterate company by email, external ID, or one typed user property and return survey participation totals.

Input Parameters

string
User email to match; use exactly one search selector.
string
External user ID to match; use exactly one search selector.
string
Custom user property name to match; supply user_property_value and no other selector.
string
Typed scalar value for user_property_name. Its JSON type must match the stored property type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ITERATE_SEND_SURVEYIrreversibly send or schedule an email survey to one specified recipient or every previously added recipient. Requires an explicit audience and confirmation.

Input Parameters

string
Recipient email address. Required for single_recipient and forbidden for all_added_recipients.
string
Optional Unix timestamp at which to send, no more than 30 days in the future. Do not combine with delay_seconds.
string ("single_recipient" | "all_added_recipients")
required
Explicitly choose one email address or every recipient already added to the survey. all_added_recipients may send many emails.
string
Optional last name for the single recipient.
string
required
Survey ID to send.
string
Optional first name for the single recipient.
boolean
required
Must be true to confirm this externally visible, irreversible email send or schedule operation.
object
Optional custom user fields for a single recipient, keyed without the field_ prefix. Values must be strings, numbers, or booleans.
string
Optional non-negative delay before sending, in seconds. Do not combine with send_at.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not