> ## Documentation Index
> Fetch the complete documentation index at: https://docs.feedspace.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Review Form

> Returns a single review form by ID.



## OpenAPI

````yaml GET /forms/{feed_form_id}
openapi: 3.1.0
info:
  title: Feedspace API
  description: Feedspace API v3 - Feedback and testimonial management platform
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.feedspace.io/v3
security: []
paths:
  /forms/{feed_form_id}:
    get:
      tags:
        - ReviewForms
      summary: Get a review form
      description: Returns a single review form by ID.
      operationId: getReviewForm
      parameters:
        - name: feed_form_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: A review form.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ReviewForm'
              examples:
                success:
                  value:
                    data:
                      id: 251
                      project_id: 354
                      unique_form_id: form_f5Uc9agvcXRKgPdDrVCIZYc1
                      user_id: 282
                      slug: E31TFy1
                      language_id: en
                      name: Testimonial Collection Form
                      description: null
                      page_title: Share Your Feedback with Us!
                      page_main_message: >-
                        <p class="text-gray-800 dark:text-neutral-200">We value
                        your opinion. Please share your experience with us.</p>
                      messaging_description: >-
                        <p class="text-gray-800 dark:text-neutral-200">Please
                        provide your feedback along with a video or audio
                        testimonial.</p>
                      page_image: >-
                        uploads/gx8N4Q/allinone-feed-form/1766392380_cloned_1766055929FS-Shopify_App-Logo.png
                      hide_image: 0
                      favicon: uploads/gx8N4Q/workspace/1764593836workspace_favicon.png
                      submit_attributes:
                        attribution_title: Tell Us More About Yourself
                        attribution_subtitle: Help us personalize your testimonial.
                      thankyou_attributes:
                        hide_fs_signup: '1'
                        thank_you_type: thank_you_page
                        thankyou_title: Thank You for Sharing!
                        thankyou_message: >-
                          Your testimonial has been submitted successfully. We
                          appreciate your valuable feedback.
                        thankyou_reveal_text: null
                        google_review_section: 0
                        other_review_platforms:
                          items:
                            - url: https://www.trustpilot.com/review/feedspace.io
                              icon: trustpilot_other_icon.svg
                              platform: trustpilot
                              is_enabled: true
                              button_text: Trustpilot
                              button_style:
                                color: '#FFFFFF'
                                border-color: '#029862'
                                background-color: '#029862'
                        thankyou_affiliate_link: ''
                        thankyou_redirection_url: null
                        allow_video_and_shareable_link: '1'
                        other_review_platforms_enabled: '1'
                        thankyou_is_enable_affiliate_link: '0'
                      form_attributes:
                        text:
                          or_label: OR
                          modal_title: null
                          rating_type: star
                          question_text: null
                          allow_review_type: '1'
                          allow_text_review: '1'
                          button_label_back: Back
                          fields_label_name: Name
                          text_button_label: Text review
                          fields_label_email: Email
                          fields_label_photo: Avatar
                          is_required_remark: '1'
                          remark_placeholder: Submit Your Testimonial
                          submit_button_label: Submit Your Testimonial
                          option_to_add_remark: 1
                          fields_label_position: Role
                          is_mandatory_feedback: 1
                          fields_label_try_again: Try again
                          fields_try_again_title: Are you sure?
                          fields_placeholder_name: Eg. Henry Ford
                          has_allow_image_uploads: '1'
                          button_label_reload_page: Reload Page
                          fields_placeholder_email: Eg. henry@ford.com
                          audio_recording_box_title: Record your audio
                          fields_label_button_submit: Submit
                          fields_try_again_button_no: No, cancel
                          fields_try_again_sub_title: You'll lose your progress if you try again
                          fields_label_contact_number: Contact Number
                          fields_placeholder_position: Eg. CEO
                          fields_try_again_button_yes: Yes, try again
                          fields_label_photo_sub_title: Upload photo
                          thankyou_word_of_mouth_title: Share review with your friends
                          fields_label_photo_sub_title2: Pick a photo up to 15 MB
                          fields_label_organization_name: Company Name
                          screen_recording_button_tooltip: Click to start recording
                          thankyou_word_of_mouth_sub_title: >-
                            Copy link below and share with others or share on
                            social media.
                          fields_placeholder_contact_number: Eg. +1583...
                          microphone_camera_access_required: Microphone & camera access required
                          recording_label_camera_live_preview: Live preview of your camera
                          thankyou_word_of_mouth_link_tooltip: Click to Copy the Link
                          fields_placeholder_organization_name: Eg. Ford Motors
                          placeholder_capture_comment_with_media: Write a Review
                          thankyou_collect_review_platform_title: >-
                            Click on the button and you'll be redirected to the
                            platform and give your review. Your review will be
                            copied on your clipboard you can paste the review on
                            the platform.
                          browser_permission_allow_continue_title: Please Allow the Permissions to Continue.
                          microphone_camera_access_required_check: >-
                            Please check your browser or device settings and
                            allow access to microphone and camera. If you have
                            already allowed, try reloading the page.
                          recording_label_microphone_live_preview: Live preview of your microphone
                          thankyou_social_platform_button_text_g2: Review us on G2
                          microphone_camera_access_required_detect: >-
                            We couldn't detect any microphone or camera in
                            device, please make sure working microphone or
                            camera is attached or use mobile phone to record
                            your voice and video. Copy the form link and open in
                            your mobile browser.
                          microphone_camera_access_required_reload: >-
                            Please reload this page and give microphone and
                            camera access so that you can record your voice and
                            video.
                          browser_permission_allow_continue_sub_title: >-
                            We're waiting for the permission. Once you give the
                            camera & mic permission your video will be shown
                            here
                          microphone_camera_access_required_not_found: Microphone or Camera not found
                          microphone_camera_access_required_sub_title: >-
                            Please go to browser settings & give access to
                            microphone and camera so that you can record your
                            voice and video.
                          thankyou_social_platform_button_text_clutch: Review us on Clutch
                          thankyou_social_platform_button_text_google: Review us on Google
                          thankyou_social_platform_button_text_facebook: Review us on Facebook
                          recording_label_camera_microphone_live_preview: Live preview of your camera/microphone
                          thankyou_collect_review_platform_divider_title: Or, review us on other platforms
                          thankyou_social_platform_button_text_app_store: Review us on App Store
                          thankyou_social_platform_button_text_trustpilot: Review us on Trustpilot
                          thankyou_social_platform_button_text_tripadvisor: Review us on Tripadvisor
                          fields_collect_consent: >-
                            I hereby grant permission to amplify feedback on
                            social media & beyond
                        audio:
                          audio_duration: '60'
                          audio_button_label: Record Audio Testimonial
                          allow_audio_recording: '1'
                        media:
                          has_capture_comment: '0'
                          has_allow_media_review: '1'
                          has_capture_star_rating: '0'
                        video:
                          video_duration: '60'
                          video_button_label: Record Video Testimonial
                          screen_button_label: Share Your Screen
                          allow_video_recording: '1'
                          allow_screen_recording: '0'
                        branding:
                          branding_affiliate_link: https://feedspace.io/?via=wqAsw
                          is_enable_affiliate_link: '1'
                        allow_ratings:
                          allow_star_redirection: true
                          star_redirection_platforms:
                            - url: https://www.trustpilot.com/review/feedspace.io
                              icon: trustpilot_other_icon.svg
                              platform: trustpilot
                              is_enabled: true
                              button_text: Trustpilot
                              button_style:
                                color: '#FFFFFF'
                                border-color: '#029862'
                                background-color: '#029862'
                        instruction_page:
                          instruction_title: null
                          instruction_description: null
                          instruction_page_display: do_not_show
                          open_recorder_button_label: Start Recording
                        upload_file_option:
                          allow_files: []
                          text_file_upload_label: Choose a file to upload
                          allow_upload_file_option: '0'
                      custom_attributes:
                        font:
                          name: DM Sans
                          font_url: >-
                            https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&display=swap
                          provider: google
                        custom_css: null
                        shadow_size: '3'
                        border_color: '#e5e7eb'
                        shadow_color: '#000000'
                        shadow_style: blurred
                        is_show_border: '1'
                        is_show_shadow: '1'
                        reviews_widget:
                          builder_js: null
                          widget_type: null
                          unique_widget_id: null
                          show_reviews_on_form: false
                        background_type: background_gradient
                        allow_custom_css: 0
                        page_primary_color: '#144cd8'
                        page_backgound_color: '#eff6ff'
                        add_custom_background: '1'
                        allow_darken_background: '0'
                        custom_background_image: null
                        custom_background_gradient: gradient-5
                        background_image_url: null
                      media_attributes:
                        introduction_media:
                          - type: video
                            details:
                              file: ''
                              file_name: feed_Y3y9keV17658678014062.mp4
                              file_size: null
                              gif_thumb: null
                              thumbnail: ''
                              original_url: >-
                                https://feedspace-staging.s3.us-east-2.amazonaws.com/originals-introduction/introduction-video/gx8N4Q/introduction_feed_Y3y9keV17658678014062_form_f5Uc9agvcXRKgPdDrVCIZYc1_1766462239578.mp4
                              original_path: >-
                                originals-introduction/introduction-video/gx8N4Q/introduction_feed_Y3y9keV17658678014062_form_f5Uc9agvcXRKgPdDrVCIZYc1_1766462239578.mp4
                        thankyou_message_media: []
                        allow_introduction_media: '1'
                        allow_thankyou_message_media: '0'
                      review_label_ids: []
                      allow_auto_detect_language: 0
                      allow_to_remove_branding: 0
                      allow_custom_domain: 0
                      is_paused: 0
                      video_meta:
                        video_time_limit: '300'
                        upload_video_outside_app: '1'
                      audio_meta:
                        audio_time_limit: '60'
                        upload_audio_outside_app: '1'
                      branding_meta:
                        hide_fs_branding: '1'
                        allow_custom_domain: '1'
                        allow_custom_css: '0'
                      thankyou_meta:
                        allow_hide_fs_signup: '1'
                      media_meta:
                        allow_introduction_media: '1'
                        allow_thankyou_message_media: '1'
                      star_redirection_meta:
                        allow_star_redirection: '1'
                      allow_star_redirection: true
                      star_redirection_min_rating: 4
                      star_redirection_platforms:
                        - url: https://www.trustpilot.com/review/feedspace.io
                          icon: trustpilot_other_icon.svg
                          platform: trustpilot
                          is_enabled: true
                          button_text: Trustpilot
                          button_style:
                            color: '#FFFFFF'
                            border-color: '#029862'
                            background-color: '#029862'
                      public_url: https://feedspace.io/u/E31TFy1/testapp3
                      public_url_with_custom_domain: https://feedspace.io/u/E31TFy1/testapp3
                      public_display_url: feedspace.io/u/E31TFy1/testapp3
                      public_display_url_with_custom_domain: feedspace.io/u/E31TFy1/testapp3
                      is_custom_domain: false
                      uuid: gx8N4Q
                      introduction_media_url: null
                      introduction_media_thumbnail_url: null
                      thankyou_message_media_url: null
                      thankyou_message_media_thumbnail_url: null
                      branding_assets:
                        font:
                          name: DM Sans
                          font_url: >-
                            https://fonts.googleapis.com/css2?family=DM+Sans:ital,opsz,wght@0,9..40,100..1000;1,9..40,100..1000&display=swap
                          provider: google
                        primary_text_color: '#d4d4d8'
                        card_on_hover_color: '#272b31'
                        primary_button_color: '#1794cc'
                        secondary_text_color: '#a1a1aa'
                        card_background_color: '#1a1d21'
                        page_background_color: '#d4d7dc'
                      has_language_rtl: false
                      page_image_url: >-
                        https://feedspace-staging.s3.us-east-2.amazonaws.com/uploads/gx8N4Q/allinone-feed-form/1766392380_cloned_1766055929FS-Shopify_App-Logo.png
                      favicon_url: >-
                        https://feedspace-staging.s3.us-east-2.amazonaws.com/uploads/gx8N4Q/workspace/1764593836workspace_favicon.png
                      questions:
                        - id: 1333
                          feed_form_id: 251
                          question_type: 1
                          question_text: name
                          default_value: ''
                          question_label: ''
                          mandatory: 0
                          enabled: 1
                        - id: 1334
                          feed_form_id: 251
                          question_type: 1
                          question_text: email
                          default_value: ''
                          question_label: ''
                          mandatory: 0
                          enabled: 1
                        - id: 1335
                          feed_form_id: 251
                          question_type: 1
                          question_text: position
                          default_value: ''
                          question_label: ''
                          mandatory: 0
                          enabled: 0
                        - id: 1336
                          feed_form_id: 251
                          question_type: 1
                          question_text: organization_name
                          default_value: ''
                          question_label: ''
                          mandatory: 0
                          enabled: 0
                        - id: 1337
                          feed_form_id: 251
                          question_type: 1
                          question_text: contact_number
                          default_value: ''
                          question_label: ''
                          mandatory: 0
                          enabled: 0
                        - id: 1338
                          feed_form_id: 251
                          question_type: 4
                          question_text: consent
                          default_value: ''
                          question_label: >-
                            I hereby grant permission to amplify feedback on
                            social media & beyond
                          mandatory: 0
                          enabled: 1
                        - id: 1351
                          feed_form_id: 251
                          question_type: 5
                          question_text: photo
                          default_value: ''
                          question_label: photo
                          mandatory: 0
                          enabled: 0
                        - id: 1352
                          feed_form_id: 251
                          question_type: 1
                          question_text: company_url
                          default_value: ''
                          question_label: company_url
                          mandatory: 0
                          enabled: 0
                        - id: 1353
                          feed_form_id: 251
                          question_type: 5
                          question_text: company_logo
                          default_value: ''
                          question_label: company_logo
                          mandatory: 0
                          enabled: 0
                      language:
                        id: en
                        name: English
                        direction: ltr
                        is_active: 1
                        sort_order: 1
                        created_at: null
                        updated_at: null
                      other_review_platforms_styles:
                        items:
                          - platform: google
                            icon: google_other_icon.svg
                            button_text: Review us on Google
                            button_style:
                              background-color: '#FFFFFF'
                              color: '#1F2937'
                              border-color: '#E5E7EB'
                              border-width: 1px
                              border-radius: 8px
                              font-weight: '500'
                              box-shadow: 0px 1px 2px -1px rgba(0, 0, 0, 0.1)
                          - platform: trustpilot
                            icon: trustpilot_other_icon.svg
                            button_text: Review us on Trustpilot
                            button_style:
                              background-color: '#029862'
                              color: '#FFFFFF'
                              border-color: '#029862'
                              border-width: 1px
                              border-radius: 8px
                              font-weight: '500'
                              box-shadow: 0px 1px 2px -1px rgba(0, 0, 0, 0.1)
                          - platform: facebook
                            icon: facebook_other_icon.svg
                            button_text: Review us on Facebook
                            button_style:
                              background-color: '#1877F2'
                              color: '#FFFFFF'
                              border-color: '#1877F2'
                              border-width: 1px
                              border-radius: 8px
                              font-weight: '500'
                              box-shadow: 0px 1px 2px -1px rgba(0, 0, 0, 0.1)
      security:
        - basicAuth: []
components:
  schemas:
    ReviewForm:
      type: object
      properties:
        id:
          type: integer
        project_id:
          type: integer
        unique_form_id:
          type: string
        user_id:
          type: integer
        slug:
          type: string
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        page_title:
          type:
            - string
            - 'null'
        page_main_message:
          type:
            - string
            - 'null'
        messaging_description:
          type:
            - string
            - 'null'
        page_image:
          type:
            - string
            - 'null'
        hide_image:
          type: integer
        submit_attributes:
          type: object
        thankyou_attributes:
          type: object
        form_attributes:
          type: object
        custom_attributes:
          type: object
        allow_auto_detect_language:
          type: integer
        allow_to_remove_branding:
          type: integer
        allow_custom_domain:
          type: integer
        video_meta:
          type: object
        audio_meta:
          type: object
        branding_meta:
          type: object
        allow_star_redirection:
          type: integer
        public_url:
          type: string
        public_url_with_custom_domain:
          type: string
        public_display_url:
          type: string
        public_display_url_with_custom_domain:
          type: string
        is_custom_domain:
          type: boolean
        uuid:
          type: string
        page_image_url:
          type:
            - string
            - 'null'
        questions:
          type: array
          items:
            type: object
        other_review_platforms_styles:
          type: object
          description: Configuration styles for other review platforms
          properties:
            items:
              type: array
              items:
                type: object
                properties:
                  platform:
                    type: string
                    description: Platform identifier (e.g., google, trustpilot, facebook)
                  icon:
                    type:
                      - string
                      - 'null'
                    description: Icon filename for the platform
                  button_text:
                    type:
                      - string
                      - 'null'
                    description: Default button text for the platform
                  button_style:
                    type: object
                    description: Button styling configuration
                    additionalProperties:
                      type: string
      required:
        - name
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: >-
        HTTP Basic Authentication using API Key and Secret Key. The credentials
        should be Base64 encoded in the format 'api_key:secret_key'. You can
        obtain your API Key and Secret Key from Feedspace → Automation → API
        (https://app.feedspace.io/automation/api).

````