← Tools Reference

Refiner

Refiner integration (Marketing, Data). Imported from open-connector.

API key7 toolshttps://api.refiner.io/v1
GET
refiner_get_account_info
Retrieve the current Refiner account, project, and subscription information.

/account

GET
refiner_list_contacts
List contacts available in the connected Refiner workspace.

/contacts

3 parameters
ParamTypeRequiredDescription
pageintegeroptionalPage number to request.
pageCursorstringoptionalPagination cursor returned by a previous Refiner response.
pageLengthintegeroptionalMaximum number of records to return per page.
GET
refiner_get_contact
Retrieve a single Refiner contact by id, email, or uuid.

/contact

3 parameters
ParamTypeRequiredDescription
idstringoptionalExternal user identifier stored in Refiner as id.
emailstringoptionalEmail address used to identify the Refiner contact.
uuidstringoptionalRefiner UUID.
GET
refiner_list_forms
List forms in the connected Refiner workspace.

/forms

6 parameters
ParamTypeRequiredDescription
uuidstringoptionalOptional form UUID filter.
typestringoptionalForm state filter accepted by Refiner.
currentPageintegeroptionalCurrent page number to request.
pageLengthintegeroptionalMaximum number of records to return per page.
showConfigbooleanoptionalWhether to include the full form config in the response.
showInfobooleanoptionalWhether to include form info metadata.
GET
refiner_list_segments
List segments in the connected Refiner workspace.

/segments

3 parameters
ParamTypeRequiredDescription
uuidstringoptionalOptional segment UUID filter.
currentPageintegeroptionalCurrent page number to request.
pageLengthintegeroptionalMaximum number of records to return per page.
GET
refiner_list_responses
List survey responses collected in Refiner.

/responses

9 parameters
ParamTypeRequiredDescription
currentPageintegeroptionalCurrent page number to request.
pageCursorstringoptionalPagination cursor returned by a previous Refiner response.
pageLengthintegeroptionalMaximum number of records to return per page.
statusstringoptionalResponse status filter accepted by Refiner.
formUuidstringoptionalFilter responses by form UUID.
contactUuidstringoptionalFilter responses by contact UUID.
segmentUuidstringoptionalFilter responses by segment UUID.
dateRangeStartstringoptionalDate in YYYY-MM-DD format.
dateRangeEndstringoptionalDate in YYYY-MM-DD format.
GET
refiner_get_reporting
Retrieve Refiner reporting metrics for forms, segments, and questions.

/reporting

7 parameters
ParamTypeRequiredDescription
reportTypestringrequiredReporting metric family to request from Refiner.
questionIdentifiersarrayoptionalQuestion identifiers used to scope the reporting result.
formUuidsarrayoptionalForm UUIDs used to scope the reporting result.
segmentUuidsarrayoptionalSegment UUIDs used to scope the reporting result.
tagUuidsarrayoptionalTag UUIDs used to scope the reporting result.
dateRangeStartstringoptionalDate in YYYY-MM-DD format.
dateRangeEndstringoptionalDate in YYYY-MM-DD format.