> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Iterate

> Iterate is a customer feedback platform for distributing surveys, analyzing responses, and managing company user privacy data.

![Iterate logo](https://mintcdn.com/composio-preview/tIuAovF9-7pXq2wA/images/toolkits/iterate.svg?fit=max\&auto=format\&n=tIuAovF9-7pXq2wA\&q=85\&s=387b453aced65d77ca3b0a04185445e4)

* **Category:** forms & surveys
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 13
* **Triggers:** 0
* **Slug:** `ITERATE`
* **Version:** 20261101\_00

## Tools

> [accordion] Add Survey Recipient
>
> **Slug:** `ITERATE_ADD_SURVEY_RECIPIENT`
>
> Add one email recipient to a survey for a later send without sending the survey now.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Recipient email address.
>
> **last\_name** `string`
>
> Recipient last name.
>
> **survey\_id** `string` *required*
>
> Survey ID to receive the recipient.
>
> **first\_name** `string`
>
> Recipient first name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Anonymize Company User
>
> **Slug:** `ITERATE_ANONYMIZE_COMPANY_USER`
>
> Irreversibly 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
>
> **user\_id** `string` *required*
>
> Exact Iterate user ID to anonymize, normally returned by Search Company Users.
>
> **confirm\_anonymization** `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.
>
> **include\_response\_properties** `boolean`
>
> Also irreversibly remove properties stored on the user's responses; defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Anonymize Company Users
>
> **Slug:** `ITERATE_BULK_ANONYMIZE_COMPANY_USERS`
>
> Irreversibly 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
>
> **emails** `array`
>
> One or more email addresses selecting users to anonymize.
>
> **external\_ids** `array`
>
> One or more external user IDs selecting users to anonymize.
>
> **user\_properties** `array`
>
> One or more typed user-property matches selecting users to anonymize.
>
> **confirm\_bulk\_anonymization** `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.
>
> **include\_response\_properties** `boolean`
>
> Also irreversibly remove properties stored on matching users' responses; defaults to false.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk Delete Company User Data
>
> **Slug:** `ITERATE_BULK_DELETE_COMPANY_USER_DATA`
>
> Permanently 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
>
> **emails** `array`
>
> Email addresses selecting users and responses for permanent deletion.
>
> **external\_ids** `array`
>
> External user IDs selecting users and responses for permanent deletion.
>
> **user\_properties** `array`
>
> Typed user-property matches selecting users and responses for deletion.
>
> **confirm\_bulk\_permanent\_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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Company User Data
>
> **Slug:** `ITERATE_DELETE_COMPANY_USER_DATA`
>
> Permanently 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
>
> **user\_id** `string` *required*
>
> Exact Iterate user ID whose object and responses will be permanently deleted, normally returned by Search Company Users.
>
> **confirm\_permanent\_deletion** `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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Survey
>
> **Slug:** `ITERATE_GET_SURVEY`
>
> Return one survey's configuration and questions by survey ID. The action fails when Iterate embeds an error in an HTTP 200 response.
>
> #### Input Parameters
>
> **survey\_id** `string` *required*
>
> Survey ID returned by List Surveys.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Survey Stats
>
> **Slug:** `ITERATE_GET_SURVEY_STATS`
>
> Return delivery, display, response-count, and response-rate statistics for one survey.
>
> #### Input Parameters
>
> **survey\_id** `string` *required*
>
> Survey ID whose aggregate statistics to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import Survey Recipients
>
> **Slug:** `ITERATE_IMPORT_SURVEY_RECIPIENTS`
>
> Add a non-empty batch of email recipients to a survey without sending it, and return duplicate, failure, and success counts.
>
> #### Input Parameters
>
> **survey\_id** `string` *required*
>
> Survey ID to receive the imported recipients.
>
> **recipients** `array` *required*
>
> One or more recipients to add. Each recipient requires an email address and may include a first and last name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Survey Response Groups
>
> **Slug:** `ITERATE_LIST_SURVEY_RESPONSE_GROUPS`
>
> Return one reverse-chronological page of completed survey submissions grouped by user, plus a continuation cursor.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation URL returned as next\_cursor by the previous call; omit for the first page and pass it back unchanged.
>
> **survey\_id** `string` *required*
>
> Survey ID whose completed user-grouped submissions to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Survey Responses
>
> **Slug:** `ITERATE_LIST_SURVEY_RESPONSES`
>
> Return one reverse-chronological page of individual answers for a survey, with an optional date range and continuation cursor.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned as next\_cursor by the previous call; omit for the first page and pass it back unchanged.
>
> **end\_date** `number`
>
> Optional inclusive upper bound as a Unix timestamp.
>
> **survey\_id** `string` *required*
>
> Survey ID whose individual responses to list.
>
> **start\_date** `number`
>
> Optional inclusive lower bound as a Unix timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Surveys
>
> **Slug:** `ITERATE_LIST_SURVEYS`
>
> List surveys available to the connected Iterate API key, including survey IDs and company IDs when returned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Company Users
>
> **Slug:** `ITERATE_SEARCH_COMPANY_USERS`
>
> Find one user in the connected Iterate company by email, external ID, or one typed user property and return survey participation totals.
>
> #### Input Parameters
>
> **email** `string`
>
> User email to match; use exactly one search selector.
>
> **external\_id** `string`
>
> External user ID to match; use exactly one search selector.
>
> **user\_property\_name** `string`
>
> Custom user property name to match; supply user\_property\_value and no other selector.
>
> **user\_property\_value** `string`
>
> Typed scalar value for user\_property\_name. Its JSON type must match the stored property type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Send Survey
>
> **Slug:** `ITERATE_SEND_SURVEY`
>
> Irreversibly send or schedule an email survey to one specified recipient or every previously added recipient. Requires an explicit audience and confirmation.
>
> #### Input Parameters
>
> **email** `string`
>
> Recipient email address. Required for single\_recipient and forbidden for all\_added\_recipients.
>
> **send\_at** `string`
>
> Optional Unix timestamp at which to send, no more than 30 days in the future. Do not combine with delay\_seconds.
>
> **audience** `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.
>
> **last\_name** `string`
>
> Optional last name for the single recipient.
>
> **survey\_id** `string` *required*
>
> Survey ID to send.
>
> **first\_name** `string`
>
> Optional first name for the single recipient.
>
> **confirm\_send** `boolean` *required*
>
> Must be true to confirm this externally visible, irreversible email send or schedule operation.
>
> **custom\_fields** `object`
>
> Optional custom user fields for a single recipient, keyed without the field\_ prefix. Values must be strings, numbers, or booleans.
>
> **delay\_seconds** `string`
>
> Optional non-negative delay before sending, in seconds. Do not combine with send\_at.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
