Get how-it-works blocks

Overview

Get the 'how it works' blocks for an account, filtered by type.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.
• Values for the required query parameter company_id — see the table below.

Base URL

Endpoint

GET /api/v1/account/faq/get-block

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• Target company comes from the company_id query param. There is no ownership/partner-tree scoping, so any authenticated Partner or Account user can read any company's blocks.

• Role only changes which company_id you pass.

Rate limit

• No rate limit.

Query parameters

• Query: company_id (integer, required) — must be an existing account.
• Query: type (string, optional) — one of landing_page, widget. Note: the controller filters where('type', $type); when you omit type it filters on type = null, so pass type to get rows back.

Response

• data.status (string) — literal "success".
• data.data (array) — list of RsBlock records. Each item: id, company_id, type, content, image_url, image_direction, status, created_at, updated_at, deleted_at.

200 OK · 200

{
  "data": {
    "status": "success",
    "data": [
      {
        "id": 7,
        "company_id": 34,
        "type": "landing_page",
        "content": "<p>Tell us about your project</p>",
        "image_url": "https://s3.amazonaws.com/bucket/how-it-works/65f2a1.png",
        "image_direction": "left",
        "status": "active"
      }
    ]
  }
}

422 Validation error · 422

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

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/account/faq/get-block?company_id=123&type=landing_page" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'