Skip to main content
GET
/
review_embeds
/
{id}
Retrieve a review embed
curl --request GET \
  --url https://api.pocketflows.com/review_embeds/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "id": "<string>",
  "url": "<string>",
  "business": "<string>",
  "customer": "<string>",
  "review": "<string>",
  "review_embed_config": {
    "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

Response

200 - application/json

The ReviewEmbed object

id
string
required

The ID of the review embed

url
string
required

The URL to embed the review request

business
string
required

The ID of the business

customer
string | null
required

The ID of the customer

review
string | null
required

The ID of the review

review_embed_config
The Review Embed Config object · object
required

The review embed config