Skip to main content
GET
/
review_embed_configs
/
{id}
Retrieve a review embed config by ID
curl --request GET \
  --url https://api.pocketflows.com/review_embed_configs/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "title": "<string>",
  "review_text_prompt": "<string>",
  "review_text_placeholder": "<string>",
  "min_stars_to_prompt_review": 123,
  "google_request_review_url": "<string>",
  "submit_cta": "<string>",
  "slug": "<string>",
  "redirect_to_google_request_review_url": true,
  "permanent_review_page_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
id
string
required

The ID of the review embed config

Response

200 - application/json

The review embed configuration

​
id
string
required

The ID of the review embed config

​
title
string
required

The title of the review embed

​
review_text_prompt
string
required

The prompt for the review text

​
review_text_placeholder
string
required

The placeholder for the review text

​
min_stars_to_prompt_review
integer
required

The minimum number of stars to prompt for a review

​
google_request_review_url
string | null
required

The URL to request a review from Google

​
submit_cta
string
required

The text for the submit button

​
slug
string
required

The unique identifier that appears in the public review URL

​
redirect_to_google_request_review_url
boolean
required

Whether to redirect directly to the Google review link

​
permanent_review_page_url
string
required

The permanent review page URL