> ## 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.

# Refiner

> Refiner is a customer feedback and survey tool designed to help businesses collect and analyze user insights.

![Refiner logo](https://mintcdn.com/composio-preview/YYC5iurbUCUzEs77/images/toolkits/refiner.svg?fit=max\&auto=format\&n=YYC5iurbUCUzEs77\&q=85\&s=80e82b0fe9058e5a220bb842266145cb)

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

## Tools

> [accordion] Delete Contact
>
> **Slug:** `REFINER_DELETE_CONTACT`
>
> Deletes a specific contact identified by user ID or email. Deleting the contact also removes their survey responses.
>
> #### Input Parameters
>
> **id** `string`
>
> Your user ID that was used when the contact was created. This is the primary identifier for the contact.
>
> **email** `string`
>
> The email address of the contact to delete. Can be used as an alternative to id.
>
> #### 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 Account Info
>
> **Slug:** `REFINER_GET_ACCOUNT_INFO`
>
> Retrieves Refiner account information including the subscription plan, usage counters, available limits, metric update timestamps, and per-environment usage statistics.
>
> #### 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 Contact
>
> **Slug:** `REFINER_GET_CONTACT`
>
> Retrieve detailed information about a specific contact using their ID, email, or UUID. Returns all stored attributes, segments, and account information.
>
> #### Input Parameters
>
> **id** `string`
>
> Your user ID used when the contact was created.
>
> **uuid** `string`
>
> Refiner-generated UUID of the contact.
>
> **email** `string`
>
> Email address of the contact.
>
> #### 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 Contacts
>
> **Slug:** `REFINER_GET_CONTACTS`
>
> Tool to retrieve a list of contacts from your Refiner account. Use when you need to filter or paginate through contacts.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination, must be >= 1.
>
> **search** `string`
>
> Filter by contact email, ID, or name.
>
> **order\_by** `string ("first_seen_at" | "last_seen_at" | "last_form_submission_at")`
>
> Order contacts by this field.
>
> **form\_uuid** `string`
>
> Filter contacts by survey UUID.
>
> **page\_cursor** `string`
>
> Cursor for fetching next page in large result sets.
>
> **page\_length** `integer`
>
> Number of items per page (max 1000).
>
> **segment\_uuid** `string`
>
> Filter contacts by segment UUID.
>
> #### 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 Forms
>
> **Slug:** `REFINER_GET_FORMS`
>
> Tool to retrieve a list of forms (surveys) from your Refiner account with optional filtering and pagination. Use when you need to list surveys by state, page, or include extra info/config.
>
> #### Input Parameters
>
> **list** `string ("all" | "published" | "drafts" | "archived" | "all_with_archived")`
>
> Which surveys to include by state. One of: all, published, drafts, archived, all\_with\_archived.
>
> **page** `integer`
>
> Page number for pagination, must be >=1.
>
> **page\_length** `integer`
>
> Number of items per page (max 1000).
>
> **include\_info** `boolean`
>
> If True, include additional meta data (timestamps, counts, folder, page\_url).
>
> **include\_config** `boolean`
>
> If True, include full survey configuration and elements.
>
> #### 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 Reporting
>
> **Slug:** `REFINER_GET_REPORTING`
>
> Tool to retrieve aggregated reporting data for surveys including metrics and analytics. Use when you need survey analytics over a time range filtered by type, question identifiers, tags, forms, or segments.
>
> #### Input Parameters
>
> **type** `string ("nps" | "csat" | "ratings" | "distribution" | "count")` *required*
>
> Type of report to generate. One of 'nps', 'csat', 'ratings', 'distribution', or 'count'.
>
> **tag\_uuids** `array`
>
> Only include data points linked to these tag UUIDs. NOTE: This parameter may not be supported by the current API version.
>
> **form\_uuids** `array`
>
> Only include data points from these form (survey) UUIDs. NOTE: This parameter may not be supported by the current API version.
>
> **segment\_uuids** `array`
>
> Only include data points for users in these segment UUIDs. NOTE: This parameter may not be supported by the current API version.
>
> **date\_range\_end** `string`
>
> ISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to end date range. Only data before this time is counted.
>
> **date\_range\_start** `string`
>
> ISO8601 timestamp (e.g. 'YYYY-MM-DDThh:mm:ssZ') to start date range. Only data on or after this time is counted.
>
> **question\_identifiers** `array`
>
> Only include data points for these question identifiers. If omitted, all matching questions are included. NOTE: This parameter may not be supported by the current API version.
>
> #### 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 Responses
>
> **Slug:** `REFINER_GET_RESPONSES`
>
> Retrieves a page of survey responses with optional filtering and pagination. Completed responses are selected by default; partials or all survey views can be requested, but responses with null required timestamp fields may fail validation.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination. Must be >=1. Default is 1.
>
> **search** `string`
>
> Search by contact user ID, response UUID, email, or name.
>
> **include** `string ("completed" | "partials" | "all")`
>
> Which responses to include: completed, partials, or all.
>
> **form\_uuid** `string`
>
> Filter responses by a single survey form UUID.
>
> **form\_uuids** `array`
>
> Filter responses by multiple survey form UUIDs.
>
> **page\_cursor** `string`
>
> Cursor token for next page; use pagination.next\_page\_cursor.
>
> **page\_length** `integer`
>
> Items per page. Default is 50; maximum is 1000.
>
> **segment\_uuid** `string`
>
> Filter responses by a single segment UUID.
>
> **segment\_uuids** `array`
>
> Filter responses by multiple segment UUIDs.
>
> **date\_range\_end** `string`
>
> ISO-8601 end date (exclusive) for last\_data\_reception\_at.
>
> **with\_attributes** `boolean`
>
> If true, include full contact attributes (API expects 1 or 0).
>
> **date\_range\_start** `string`
>
> ISO-8601 start date (inclusive) for last\_data\_reception\_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

> [accordion] Get Segments
>
> **Slug:** `REFINER_GET_SEGMENTS`
>
> Tool to retrieve a list of user segments from your Refiner account. Use when you need to view or paginate segments.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number for pagination, must be >= 1.
>
> **page\_cursor** `string`
>
> Cursor for fetching next page in large result sets.
>
> **page\_length** `integer`
>
> Number of items per page (max 1000).
>
> #### 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] Track Event
>
> **Slug:** `REFINER_TRACK_EVENT`
>
> Records a named event for a user identified by user ID or email. If no user matches, Refiner creates a new user.
>
> #### Input Parameters
>
> **id** `string`
>
> Refiner user ID. Required if email is not provided.
>
> **email** `string`
>
> User email address. Required if id is not provided.
>
> **event** `string` *required*
>
> Name of the event to track for the specified user.
>
> #### 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] Update Contact
>
> **Slug:** `REFINER_UPDATE_CONTACT`
>
> Tool to create or update a contact's attributes or account. Identifies a contact by `id` or `email` and updates their traits or account grouping. If the contact doesn't exist, it will be created automatically.
>
> #### Input Parameters
>
> **id** `string`
>
> Your internal user ID. Required if email is not provided.
>
> **email** `string`
>
> User email address. Required if id is not provided.
>
> **account** `object`
>
> Nested account object for grouping users. Must include an `id` field; additional traits allowed.
>
> **attributes** `object`
>
> Traits to update (key=trait slug). Values: string (\<=255 chars), integer, or boolean. Date-time strings accepted for keys ending with `_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
