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

Tools

Slug: REFINER_DELETE_CONTACTDeletes a specific contact identified by user ID or email. Deleting the contact also removes their survey responses.

Input Parameters

string
Your user ID that was used when the contact was created. This is the primary identifier for the contact.
string
The email address of the contact to delete. Can be used as an alternative to id.

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: REFINER_GET_ACCOUNT_INFORetrieves Refiner account information including the subscription plan, usage counters, available limits, metric update timestamps, and per-environment usage statistics.

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: REFINER_GET_CONTACTRetrieve detailed information about a specific contact using their ID, email, or UUID. Returns all stored attributes, segments, and account information.

Input Parameters

string
Your user ID used when the contact was created.
string
Refiner-generated UUID of the contact.
string
Email address of the contact.

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: REFINER_GET_CONTACTSTool to retrieve a list of contacts from your Refiner account. Use when you need to filter or paginate through contacts.

Input Parameters

integer
Page number for pagination, must be >= 1.
Filter by contact email, ID, or name.
string ("first_seen_at" | "last_seen_at" | "last_form_submission_at")
Order contacts by this field.
string
Filter contacts by survey UUID.
string
Cursor for fetching next page in large result sets.
integer
Number of items per page (max 1000).
string
Filter contacts by segment UUID.

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: REFINER_GET_FORMSTool 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

string ("all" | "published" | "drafts" | "archived" | "all_with_archived")
Which surveys to include by state. One of: all, published, drafts, archived, all_with_archived.
integer
Page number for pagination, must be >=1.
integer
Number of items per page (max 1000).
boolean
If True, include additional meta data (timestamps, counts, folder, page_url).
boolean
If True, include full survey configuration and elements.

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: REFINER_GET_REPORTINGTool 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

string ("nps" | "csat" | "ratings" | "distribution" | "count")
required
Type of report to generate. One of ‘nps’, ‘csat’, ‘ratings’, ‘distribution’, or ‘count’.
array
Only include data points linked to these tag UUIDs. NOTE: This parameter may not be supported by the current API version.
array
Only include data points from these form (survey) UUIDs. NOTE: This parameter may not be supported by the current API version.
array
Only include data points for users in these segment UUIDs. NOTE: This parameter may not be supported by the current API version.
string
ISO8601 timestamp (e.g. ‘YYYY-MM-DDThh:mm:ssZ’) to end date range. Only data before this time is counted.
string
ISO8601 timestamp (e.g. ‘YYYY-MM-DDThh:mm:ssZ’) to start date range. Only data on or after this time is counted.
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

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: REFINER_GET_RESPONSESRetrieves 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

integer
Page number for pagination. Must be >=1. Default is 1.
string
Search by contact user ID, response UUID, email, or name.
string ("completed" | "partials" | "all")
Which responses to include: completed, partials, or all.
string
Filter responses by a single survey form UUID.
array
Filter responses by multiple survey form UUIDs.
string
Cursor token for next page; use pagination.next_page_cursor.
integer
Items per page. Default is 50; maximum is 1000.
string
Filter responses by a single segment UUID.
array
Filter responses by multiple segment UUIDs.
string
ISO-8601 end date (exclusive) for last_data_reception_at.
boolean
If true, include full contact attributes (API expects 1 or 0).
string
ISO-8601 start date (inclusive) for last_data_reception_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
Slug: REFINER_GET_SEGMENTSTool to retrieve a list of user segments from your Refiner account. Use when you need to view or paginate segments.

Input Parameters

integer
Page number for pagination, must be >= 1.
string
Cursor for fetching next page in large result sets.
integer
Number of items per page (max 1000).

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: REFINER_TRACK_EVENTRecords a named event for a user identified by user ID or email. If no user matches, Refiner creates a new user.

Input Parameters

string
Refiner user ID. Required if email is not provided.
string
User email address. Required if id is not provided.
string
required
Name of the event to track for the specified user.

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: REFINER_UPDATE_CONTACTTool 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

string
Your internal user ID. Required if email is not provided.
string
User email address. Required if id is not provided.
object
Nested account object for grouping users. Must include an id field; additional traits allowed.
object
Traits to update (key=trait slug). Values: string (<=255 chars), integer, or boolean. Date-time strings accepted for keys ending with _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