# Documentation - Feedbackflow

## Docs

- [Get Contact State](https://docs.feedbackflowhq.com/api-reference/client-api->-contacts/get-contact-state.md): Retrieves a contact's state including their segments, displays, responses and other tracking information. If the contact doesn't exist, it will be created.
- [Update Contact (Attributes)](https://docs.feedbackflowhq.com/api-reference/client-api->-contacts/update-contact-attributes.md): Update a contact's attributes in Formbricks to keep them in sync with your app or when you want to set a custom attribute in Formbricks.
- [Create Display](https://docs.feedbackflowhq.com/api-reference/client-api->-display/create-display.md): Create a new display for a valid survey ID. If a userId is passed, the display is linked to the user.
- [Update Display](https://docs.feedbackflowhq.com/api-reference/client-api->-display/update-display.md): Update an Display for a user. A use case can be when a user submits a response & you want to link it to an existing display.
- [Get Environment State](https://docs.feedbackflowhq.com/api-reference/client-api->-environment/get-environment-state.md): Retrieves the environment state to be used in Formbricks SDKs
- [Create Response](https://docs.feedbackflowhq.com/api-reference/client-api->-response/create-response.md): Create a response for a survey and it's fields with the user's responses. The userId & meta here is optional
- [Update Response](https://docs.feedbackflowhq.com/api-reference/client-api->-response/update-response.md): Update an existing response for example when you want to mark a response as finished or you want to change an existing response's value.
- [Create or Identify User](https://docs.feedbackflowhq.com/api-reference/client-api->-user/create-or-identify-user.md): Endpoint for creating or identifying a user within the specified environment. If the user already exists, this will identify them and potentially update user attributes. If they don't exist, it will create a new user.
- [Generate API Key](https://docs.feedbackflowhq.com/api-reference/generate-key.md): Here is how you can generate an API key which gives you full access to the Feedbackflow Management API. Keep it safe!
- [Health Check](https://docs.feedbackflowhq.com/api-reference/health/health-check.md): Formbricks' Health Check endpoint to make sure the App & the Database are connected with each other & up!
- [Create Action Class](https://docs.feedbackflowhq.com/api-reference/management-api->-action-class/create-action-class.md): Create Action Class from the UI or from the API! You can read more about them [here](https://feedbackflowhq.com/docs/in-app-surveys/actions).
- [Delete Action Class](https://docs.feedbackflowhq.com/api-reference/management-api->-action-class/delete-action-class.md): Deletes an existing action class
- [Get Action Class by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-action-class/get-action-class-by-id.md): Fetch an Action Class by it's ID
- [Get All Action Classes](https://docs.feedbackflowhq.com/api-reference/management-api->-action-class/get-all-action-classes.md): Fetches all the action classes available in the environment
- [Create Attribute Class](https://docs.feedbackflowhq.com/api-reference/management-api->-attribute-class/create-attribute-class.md): Create a new Attribute Class by passing in its type as well as the name! Now just use them in your app and pass this value with a user & it'll be associated with it.
- [Delete Attribute Class](https://docs.feedbackflowhq.com/api-reference/management-api->-attribute-class/delete-attribute-class.md): Delete an attribute class by its ID. Please note that you currently cannot delete the "automatic" type of attributes. Please ignore them if you do not wish to utilise them.
- [Get All Attribute Classes](https://docs.feedbackflowhq.com/api-reference/management-api->-attribute-class/get-all-attribute-classes.md): Fetches all the available attribute classes
- [Get Attribute Class by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-attribute-class/get-attribute-class-by-id.md): Fetches an Attribute Class by its ID
- [Get All Contact Attribute Keys](https://docs.feedbackflowhq.com/api-reference/management-api->-contact-attribute-keys/get-all-contact-attribute-keys.md): Retrieve a list of all contact attribute keys defined in the current environment
- [Get Contact Attribute Key by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-contact-attribute-keys/get-contact-attribute-key-by-id.md): Retrieve a specific contact attribute key by its ID. This returns detailed information about how a particular attribute is defined in your environment.
- [Get All Contact Attributes](https://docs.feedbackflowhq.com/api-reference/management-api->-contact-attributes/get-all-contact-attributes.md): Retrieve a list of all contact attributes in the current environment
- [Get All Contacts](https://docs.feedbackflowhq.com/api-reference/management-api->-contacts/get-all-contacts.md): Retrieve a list of all contacts for the current environment
- [Get Contact by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-contacts/get-contact-by-id.md): Retrieve a specific contact by its ID
- [Me](https://docs.feedbackflowhq.com/api-reference/management-api->-me/me.md): Fetches the product associated with the passed API key
- [Delete Person](https://docs.feedbackflowhq.com/api-reference/management-api->-people/delete-person.md): Delete an identified person from Formbricks.
- [Get All Persons](https://docs.feedbackflowhq.com/api-reference/management-api->-people/get-all-persons.md): Get all the identified people from Formbricks
- [Get Person by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-people/get-person-by-id.md): Get a person by their internal ID on Formbricks. This internal ID can be found from the Get All Person endpoint.
- [Create Response](https://docs.feedbackflowhq.com/api-reference/management-api->-response/create-response.md): Create a user response using the management API
- [Delete Response](https://docs.feedbackflowhq.com/api-reference/management-api->-response/delete-response.md): Delete a response with its ID
- [Get Response by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-response/get-response-by-id.md): Fetch the entire response object based on its ID
- [Get Survey Responses](https://docs.feedbackflowhq.com/api-reference/management-api->-response/get-survey-responses.md): Pass the surveyId as a Query Parameter & only fetch responses for a specific survey that you have access to.
- [Update Response](https://docs.feedbackflowhq.com/api-reference/management-api->-response/update-response.md): Update an existing user response with new data
- [Upload Public File](https://docs.feedbackflowhq.com/api-reference/management-api->-storage/upload-public-file.md): API endpoint for uploading public files. Uploaded files are public and accessible by anyone. This endpoint requires authentication. It accepts a JSON body with fileName, fileType, environmentId, and optionally allowedFileExtensions to restrict file types. On success, it returns a signed URL for uplo…
- [Upload Public File to Local Storage](https://docs.feedbackflowhq.com/api-reference/management-api->-storage/upload-public-file-to-local-storage.md): Management API endpoint for uploading public files to local storage. This endpoint requires authentication. File metadata is provided via headers (X-File-Type, X-File-Name, X-Environment-ID, X-Signature, X-UUID, X-Timestamp) and the file is provided as a multipart/form-data file field named "file".…
- [Create Survey](https://docs.feedbackflowhq.com/api-reference/management-api->-survey/create-survey.md): Create a survey with granular settings, questions, their types, welcomeCard, thankYouCard, languages, etc right from this API. We'd however recommend you to do this via our Formbricks App with the UI for a better visual experience.
- [Delete Survey](https://docs.feedbackflowhq.com/api-reference/management-api->-survey/delete-survey.md): Delete a Survey by its ID. Please use this only when extrememly necessary.
- [Get All Surveys](https://docs.feedbackflowhq.com/api-reference/management-api->-survey/get-all-surveys.md): Fetches all existing surveys
- [Get SingleUse Links](https://docs.feedbackflowhq.com/api-reference/management-api->-survey/get-singleuse-links.md): Generates multiple single use survey links for a survey based on its id.
- [Get Survey by ID](https://docs.feedbackflowhq.com/api-reference/management-api->-survey/get-survey-by-id.md): Fetch a survey object based on its ID
- [Update Survey](https://docs.feedbackflowhq.com/api-reference/management-api->-survey/update-survey.md): Update an existing survey with new properties. This is also what we'd recommend you to do from the UI for a better visual feedback.
- [Create Webhook](https://docs.feedbackflowhq.com/api-reference/management-api->-webhook/create-webhook.md): Create a new webhook right from the API and see it active right away!
- [Delete Webhook](https://docs.feedbackflowhq.com/api-reference/management-api->-webhook/delete-webhook.md): Delete an existing webhook by provifding it's ID. It will immediately apply and not trigger again.
- [Get All Webhooks](https://docs.feedbackflowhq.com/api-reference/management-api->-webhook/get-all-webhooks.md): Retrieve a list of all webhooks for the current environment
- [Get Webhook](https://docs.feedbackflowhq.com/api-reference/management-api->-webhook/get-webhook.md): Get a specific webhook object based on its ID
- [REST API](https://docs.feedbackflowhq.com/api-reference/rest-api.md): Feedbackflow provides two APIs: the Public Client API for frontend survey interactions and the Management API for backend management tasks.
- [Test API Key](https://docs.feedbackflowhq.com/api-reference/test-key.md): Here is how you can test your API key to make sure it is working.
- [Introduction](https://docs.feedbackflowhq.com/overview/introduction.md): Welcome to the Feedbackflow Documentation!
- [What is Feedbackflow?](https://docs.feedbackflowhq.com/overview/what-is-feedbackflow.md): Get to know Feedbackflow and its capabilities.
- [XM & Surveys](https://docs.feedbackflowhq.com/xm-and-surveys/overview.md): Learn how Feedbackflow helps you gather, analyse, and report experience data.
- [Add Image / Video](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/add-image-or-video-question.md): Enhance your questions by adding images or videos. This makes instructions clearer and the survey more engaging.
- [Conditional Logic](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/conditional-logic.md): Create complex survey logic with the Logic Editor. Use conditions, actions, and variables to create a personalized survey experience.
- [Email Follow-ups](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/email-followups.md): Follow-ups are a feature that allows you to send emails to your users on different survey events.
- [Hidden Fields](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/hidden-fields.md): Add data to a submission without asking the user to type it in. This feature is especially useful when you already have information about a user that you want to use in the analysis of the survey results (e.g. `payment plan` or `email`).
- [Hide Back Button](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/hide-back-button.md): Learn how to hide the back button in surveys.
- [Limit Submissions](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/limit-submissions.md): Automatically close your survey after reaching a set number of responses in Feedbackflow. This is useful for limited offers, exclusive surveys, or when you need a specific sample size.
- [User Metadata](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/metadata.md): Feedbackflow captures metadata of your users for you when they fill a survey. This metadata is useful for understanding the context in which the user filled the survey. For example, if you are running a marketing campaign, you can understand which source is driving the most responses. Or if you are…
- [Multi-language Surveys](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/multi-language-surveys.md): Create surveys that support multiple languages using translations. This helps you reach a diverse audience without making separate surveys for each language. It also simplifies survey creation, delivery, and analysis for multilingual audiences.
- [Custom Styling](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/overwrite-styling.md): Overwrite the global styling theme for individual surveys to create unique styles for each survey.
- [Partial Submissions](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/partial-submissions.md): Capture and analyze partial submissions, providing detailed insights into how participants interact with each question within your survey. This feature is crucial for identifying specific points where respondents may disengage, allowing you to understand and address drop-offs effectively.
- [Recall Data](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/recall.md): Personalize your surveys by dynamically inserting data from URL parameters or previous answers into questions and descriptions. The Recall Data feature helps create engaging, adaptive survey experiences tailored to each respondent.
- [Schedule Start & End Dates](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/schedule-start-end-dates.md): Optimize your survey management with custom Start & End Conditions in Feedbackflow. This feature allows you to control exactly when your survey is available for responses and when it should close, making it ideal for time-sensitive or number-of-response-limited surveys.
- [Shareable Dashboards](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/shareable-dashboards.md): Create public, shareable versions of your survey results dashboards. This feature enables you to easily share survey results with stakeholders, team members, or the public without granting access to your Feedbackflow account.
- [Variables](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/general-features/variables.md): Variables are a powerful feature in Feedbackflow that allows you to keep track of data variables when user fills a form. This feature is especially useful when you want to use your survey as a quiz.
- [Kit](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/integrations/kit.md): A step-by-step guide to integrate Kit with Feedbackflow.
- [Notion](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/integrations/notion.md): The notion integration allows you to automatically send responses to a Notion database of your choice.
- [Showit](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/integrations/showit.md): A step-by-step guide to integrate Webflow with Showit.
- [Thinkific](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/integrations/thinkific.md): A step-by-step guide to integrate Thinkific with Feedbackflow.
- [Webflow](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/integrations/webflow.md): A step-by-step guide to integrate Webflow with Feedbackflow.
- [Data Prefilling](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/data-prefilling.md): URL Data Prefilling for Link Surveys in Feedbackflow
- [Embed Surveys](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/embed-surveys.md): Embed Feedbackflow surveys seamlessly into your website using an iframe & Email using code snippets.
- [PIN Protected Surveys](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/pin-protected-surveys.md): Enhance the security and exclusivity of your surveys by requiring respondents to enter a secure 4 digit PIN to access your survey. Learn how to enable PIN protection and the benefits it offers.
- [Quickstart - Link Surveys](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/quickstart.md): Create your first link survey in under 5 minutes.
- [Single Use Links](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/single-use-links.md): Make sure that each respondent only replies once with single use links.
- [Source Tracking](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/source-tracking.md): Track the source of your users in an easy & compliant way!
- [Start At Specific Question](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/start-at-question.md): Start a survey at a specific question using the URL to skip the initial questions.
- [Verify Email](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/link-surveys/verify-email-before-survey.md): Verify email before accessing surveys
- [Address](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/address.md): The Address question type allows respondents to input their address details, including multiple fields such as address lines, city, state, and country. You can configure the question by adding a title, an optional description, and toggling specific fields to be required.
- [Consent](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/consent.md): The Consent card is used to obtain user agreement regarding a product, service, or policy. It features a bold statement or question as the title, followed by a brief description. At the end of the card, users can confirm their consent by checking a checkbox to indicate their agreement.
- [Contact Info](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/contact-info.md): The Contact Info question type allows respondents to provide their basic contact information such as name, email, and phone number. You can customize the form with a title, an optional description, and control which fields to display and require.
- [Date](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/date.md): The Date question type allows respondents to provide a date, such as when they are available or when an event is scheduled. It features a title to guide the respondent on what date to enter, and an optional description to provide further details or context.
- [File Upload](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/file-upload.md): The File Upload question type allows respondents to upload files related to your survey, such as production documents or requirement specifications. It features a title to guide the user on what to upload and an optional description to provide additional context.
- [Free Text](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/free-text.md): Free text questions allow respondents to enter a custom answer.
- [Matrix](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/matrix.md): Matrix questions allow respondents to select a value for each option presented in rows.
- [Net Promoter Score](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/net-promoter-score.md): Net Promoter Score questions allow respondents to rate a question on a scale from 0 to 10. Displays a title and a list of radio buttons for the respondent to choose from.
- [Ranking](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/ranking.md): Ranking questions let respondents select options in order from 1 to the total number of options. As they make their choices, the list is automatically rearranged in numerical order.
- [Rating](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/rating.md): Rating questions allow respondents to rate questions on a scale
- [Schedule A Meeting](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/schedule-a-meeting.md): The Schedule A Meeting question type allows respondents to book a meeting by selecting a date and time. It includes a title to guide the respondent, along with an optional description to provide additional context for the meeting setup.
- [Multi Select](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/select-multiple.md): Multi select questions allow respondents to select several answers from a list
- [Picture Selection](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/select-picture.md): Picture selection questions allow respondents to select one or more images from a list
- [Single Select](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/select-single.md): Single select questions allow respondents to select one answer from a list
- [Statement (Call to Action)](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/question-type/statement-cta.md): The Statement question type allows you to display descriptive information in your survey, such as a message or instruction.
- [Actions](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/actions.md): Actions are predefined events within your app that prompt Feedbackflow to display a survey when triggered. These are detected by the Feedbackflow widget, which then presents the appropriate survey based on your predefined settings.
- [Advanced Targeting](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/advanced-targeting.md): Advanced Targeting allows you to show surveys to a specific segment of your users. You can target surveys based on user attributes, device type, and more. This helps you get more relevant insights while keeping survey fatigue at a minimum. After the initial setup, you can target any segment without…
- [Framework Guides](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/framework-guides.md): Easily add the Feedbackflow App Survey SDK to your app with guides for different frameworks.
- [Quickstart - Web & App Surveys](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/quickstart.md): App surveys deliver 6–10x higher conversion rates compared to email surveys. If you are new to Feedbackflow, follow the steps in this guide to launch a survey in your web or mobile app (React Native) within 10–15 minutes.
- [Recontact Options](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/recontact.md): Recontact options in Feedbackflow enable you to manage how often and under what conditions a survey is shown to a user. This feature is crucial for balancing effective feedback collection with a positive user experience by preventing survey fatigue.
- [Survey % of Users](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/show-survey-to-percent-of-users.md): Feedbackflow allows you to display surveys to only a percentage of your targeted users. This is helpful for surveying on public facing website.
- [User Identification](https://docs.feedbackflowhq.com/xm-and-surveys/surveys/website-app-surveys/user-identification.md): User Identification helps you to not only segment your users but also to see more information about the user who responded to a survey. This helps you to target surveys to specific user segments and see more information about the user who responded to a survey.

## OpenAPI Specs

- [openapi](https://docs.feedbackflowhq.com/api-reference/openapi.json)
- [api](https://docs.feedbackflowhq.com/docs/api.yaml)