Get landing page data (public)

Overview

Public read of a company's hosted landing-page widget configuration — the header, button, content, slider, plan, FAQ, and footer props, plus the FAQs, how-it-works and testimonials blocks and the partner referral code. The web app uses it to render the marketing landing page before login. When no saved widget exists, a full set of defaults is returned. Image paths are returned as fully-qualified URLs (served from the S3/CloudFront CDN).

Prerequisites

No authentication required — this endpoint is public.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

GET /api/v1/custom-landing-page/data

Authentication

No authentication required. This endpoint is public — its route lives in the pre-login public reference group, so no bearer token is sent.

Rate limit

100 requests/min per IP (public group).

Query parameters

Field	Type	Required	Description
`company_id`	string	Required	Either a numeric company id or an active referral code (resolved to its company id).

How it works

200 with the widget config object under data.data.
422 when you omit company_id.

Response

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "headerProps": {
        "logoURL": "",
        "logoImage": "https://d2ny6zb7otrnhl.cloudfront.net/landing_page_logo/logo.png"
      },
      "buttonProps": {
        "startButtonText": "Register Now",
        "startButtonFontColor": "#ffffff",
        "startButtonBackgroundColor": "#1459c4",
        "contactButtonText": "Contact sales",
        "contactButtonFontColor": "#1459c4",
        "contactButtonBackgroundColor": "#ffffff",
        "contactButtonURL": ""
      },
      "contentProps": {
        "contentHeading": "Stop dealing with the headache of responding to your reviews",
        "contentDescription": "Save time, boost your ranking, and build brand loyalty with a personalized review response service.",
        "youtubeThumbnail": "",
        "youtubeUrl": "https://response-scribe.s3.us-east-1.amazonaws.com/assets/sample/ResponseScribe.mp4",
        "hideVideoToggle": false
      },
      "sliderProps": {
        "sliderHeading": "Trusted by over 10,000 local businesses",
        "sliderImagesToggle": false,
        "sliderImages": null
      },
      "planProps": {
        "planText": "Choose the plan that fits your needs",
        "planToggle": false,
        "customPricingButtonToggle": false
      },
      "faqProps": {
        "faqToggle": false
      },
      "footerProps": {
        "footerText": "Personalized review response service for local businesses.",
        "copyrightText": "© 2023 Shout About Us. All Rights Reserved",
        "socialIconToggle": false,
        "footerLogo": null
      },
      "referralCode": "YOUR_REFERRAL_CODE",
      "company": {
        "id": 6
      },
      "faq": [],
      "howItWorksProps": {
        "howItWorksText": "How it works",
        "howItWorksToggle": false,
        "howItWorks": []
      },
      "testimonialsProps": {
        "testimonialsText": "You're in good company",
        "testimonialsToggle": false,
        "testimonials": []
      }
    }
  }
}

422 Validation error · `422`

{
  "message": "The company id field is required.",
  "errors": {
    "company_id": [
      "The company id field is required."
    ]
  }
}

Errors

Status	Meaning
`422`	Validation error
`500`	Unexpected server error

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/custom-landing-page/data?company_id=123" \
  --header 'Accept: application/json'

Updated 8 days ago

Did this page help you?