GET
/
review-forms
/
{feed_form_id}
curl --request GET \
  --url https://api.feedspace.io/v3/review-forms/{feed_form_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'fs-workspace-id: <fs-workspace-id>'
{
  "data": {
    "id": 10391,
    "project_id": 5022,
    "unique_form_id": "form_MbgOEoTSlvsjYg8wN7NTZ1fg",
    "user_id": 7243,
    "slug": "cGdkixR",
    "name": "Test Review Form",
    "description": null,
    "page_title": "How's your experience using our Product?",
    "page_main_message": null,
    "messaging_description": null,
    "page_image": null,
    "hide_image": 0,
    "submit_attributes": {
      "attribution_title": "You're almost done!",
      "attribution_subtitle": "Please add your information"
    },
    "thankyou_attributes": {
      "thank_you_type": "thank_you_page",
      "thankyou_title": "Thank you 🤗",
      "thankyou_message": "Hurray! Your review has been submitted successfully. Thanks for your time.",
      "thankyou_reveal_text": null,
      "google_review_section": 0,
      "thankyou_redirection_url": null,
      "allow_video_and_shareable_link": 0
    },
    "form_attributes": {
      "text": {
        "modal_title": null,
        "rating_type": "star",
        "question_text": null,
        "allow_review_type": 1,
        "allow_text_review": 1,
        "text_button_label": "Write Text Review",
        "is_required_remark": 0,
        "remark_placeholder": "Add your review comment here",
        "submit_button_label": "Submit",
        "option_to_add_remark": 1,
        "is_mandatory_feedback": 1
      },
      "audio": {
        "audio_duration": 180,
        "audio_button_label": "Record Audio Review",
        "allow_audio_recording": 0
      },
      "video": {
        "video_duration": 180,
        "video_button_label": "Record Video Review",
        "screen_button_label": "Record Screen Sharing",
        "allow_video_recording": 1,
        "allow_screen_recording": 0
      },
      "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": [
          "all_video"
        ],
        "text_file_upload_label": "Choose a file to upload",
        "allow_upload_file_option": 0
      }
    },
    "custom_attributes": {
      "page_primary_color": "#144CD8",
      "page_backgound_color": "#EFF6FF"
    },
    "allow_auto_detect_language": 0,
    "allow_to_remove_branding": 0,
    "allow_custom_domain": 0,
    "video_meta": {
      "video_time_limit": "180",
      "upload_video_outside_app": "1"
    },
    "audio_meta": {
      "upload_audio_outside_app": "1"
    },
    "branding_meta": {
      "hide_fs_branding": "0",
      "allow_custom_domain": "0"
    },
    "allow_star_redirection": 0,
    "public_url": "https://www.feedspace.io/u/cGdkixR",
    "public_url_with_custom_domain": "https://www.feedspace.io/u/cGdkixR",
    "public_display_url": "feedspace.io/u/cGdkixR",
    "public_display_url_with_custom_domain": "feedspace.io/u/cGdkixR",
    "is_custom_domain": false,
    "uuid": "zhBU6t",
    "page_image_url": null,
    "questions": [
      {
        "id": 30062,
        "feed_form_id": 10391,
        "question_type": 1,
        "question_text": "name",
        "default_value": "",
        "question_label": "",
        "mandatory": 0,
        "enabled": 1
      },
      {
        "id": 30063,
        "feed_form_id": 10391,
        "question_type": 1,
        "question_text": "email",
        "default_value": "",
        "question_label": "",
        "mandatory": 0,
        "enabled": 1
      },
      {
        "id": 30064,
        "feed_form_id": 10391,
        "question_type": 4,
        "question_text": "consent",
        "default_value": "",
        "question_label": "I hereby grant permission to share this review with others.",
        "mandatory": 0,
        "enabled": 1
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

fs-workspace-id
string
required

Workspace unique ID

Path Parameters

feed_form_id
string
required

Response

200 - application/json

A review form.

The response is of type object.

GET
/
review-forms
/
{feed_form_id}
curl --request GET \
  --url https://api.feedspace.io/v3/review-forms/{feed_form_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'fs-workspace-id: <fs-workspace-id>'
{
  "data": {
    "id": 10391,
    "project_id": 5022,
    "unique_form_id": "form_MbgOEoTSlvsjYg8wN7NTZ1fg",
    "user_id": 7243,
    "slug": "cGdkixR",
    "name": "Test Review Form",
    "description": null,
    "page_title": "How's your experience using our Product?",
    "page_main_message": null,
    "messaging_description": null,
    "page_image": null,
    "hide_image": 0,
    "submit_attributes": {
      "attribution_title": "You're almost done!",
      "attribution_subtitle": "Please add your information"
    },
    "thankyou_attributes": {
      "thank_you_type": "thank_you_page",
      "thankyou_title": "Thank you 🤗",
      "thankyou_message": "Hurray! Your review has been submitted successfully. Thanks for your time.",
      "thankyou_reveal_text": null,
      "google_review_section": 0,
      "thankyou_redirection_url": null,
      "allow_video_and_shareable_link": 0
    },
    "form_attributes": {
      "text": {
        "modal_title": null,
        "rating_type": "star",
        "question_text": null,
        "allow_review_type": 1,
        "allow_text_review": 1,
        "text_button_label": "Write Text Review",
        "is_required_remark": 0,
        "remark_placeholder": "Add your review comment here",
        "submit_button_label": "Submit",
        "option_to_add_remark": 1,
        "is_mandatory_feedback": 1
      },
      "audio": {
        "audio_duration": 180,
        "audio_button_label": "Record Audio Review",
        "allow_audio_recording": 0
      },
      "video": {
        "video_duration": 180,
        "video_button_label": "Record Video Review",
        "screen_button_label": "Record Screen Sharing",
        "allow_video_recording": 1,
        "allow_screen_recording": 0
      },
      "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": [
          "all_video"
        ],
        "text_file_upload_label": "Choose a file to upload",
        "allow_upload_file_option": 0
      }
    },
    "custom_attributes": {
      "page_primary_color": "#144CD8",
      "page_backgound_color": "#EFF6FF"
    },
    "allow_auto_detect_language": 0,
    "allow_to_remove_branding": 0,
    "allow_custom_domain": 0,
    "video_meta": {
      "video_time_limit": "180",
      "upload_video_outside_app": "1"
    },
    "audio_meta": {
      "upload_audio_outside_app": "1"
    },
    "branding_meta": {
      "hide_fs_branding": "0",
      "allow_custom_domain": "0"
    },
    "allow_star_redirection": 0,
    "public_url": "https://www.feedspace.io/u/cGdkixR",
    "public_url_with_custom_domain": "https://www.feedspace.io/u/cGdkixR",
    "public_display_url": "feedspace.io/u/cGdkixR",
    "public_display_url_with_custom_domain": "feedspace.io/u/cGdkixR",
    "is_custom_domain": false,
    "uuid": "zhBU6t",
    "page_image_url": null,
    "questions": [
      {
        "id": 30062,
        "feed_form_id": 10391,
        "question_type": 1,
        "question_text": "name",
        "default_value": "",
        "question_label": "",
        "mandatory": 0,
        "enabled": 1
      },
      {
        "id": 30063,
        "feed_form_id": 10391,
        "question_type": 1,
        "question_text": "email",
        "default_value": "",
        "question_label": "",
        "mandatory": 0,
        "enabled": 1
      },
      {
        "id": 30064,
        "feed_form_id": 10391,
        "question_type": 4,
        "question_text": "consent",
        "default_value": "",
        "question_label": "I hereby grant permission to share this review with others.",
        "mandatory": 0,
        "enabled": 1
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

fs-workspace-id
string
required

Workspace unique ID

Path Parameters

feed_form_id
string
required

Response

200 - application/json

A review form.

The response is of type object.