Get how-it-works content

Overview

Get the explanatory blocks shown on the business's hosted page.

Use this to display them.

You'll need the account's company_id and the page type.

Returns the blocks. Send type: without it the list is empty.

Prerequisites

A bearer token. See Authentication.
The account's id (company_id).

Base URL

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

Endpoint

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

Authentication

Partner or Account token

company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
An account outside your tree, or one that doesn't exist, is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

Parameter	In	Type	Required	Description
`company_id`	query	integer	Yes	The account. Must exist and be inside your account tree.
`type`	query	string	No	Which page the blocks are for: `landing_page` or `widget`. Left out: the list is empty.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	array of objects	The blocks. An empty array `[]` when there are none.
`data[].id`	integer	The block's id.
`data[].company_id`	integer	The account.
`data[].type`	string	Which page the block is for: `landing_page` or `widget`.
`data[].content`	string	The HTML content.
`data[].image_url`	string or null	The block's image URL.
`data[].image_direction`	string	Which side the image is on: `left` or `right`.
`data[].status`	string	`active`.
`data[].deleted_at`	string or null	`null`.
`data[].created_at`	string	When it was saved (ISO 8601).
`data[].updated_at`	string	When it was last changed (ISO 8601).

Response payload

{
  "data": {
    "status": "success",
    "data": [
      {
        "id": 7,
        "company_id": 5994,
        "type": "landing_page",
        "content": "<p>Step one: leave a review.</p>",
        "image_url": "https://d2ny6zb7otrnhl.cloudfront.net/how-it-works/65f2a1c3d4e5f.png",
        "image_direction": "left",
        "status": "active",
        "deleted_at": null,
        "created_at": "2026-06-15T10:30:00.000000Z",
        "updated_at": "2026-06-15T10:30:00.000000Z"
      }
    ]
  }
}

Examples

Success payload

Blocks: see Response payload.

No blocks saved for that type, or type left out:

{
  "data": {
    "status": "success",
    "data": []
  }
}

Error payload

422 company_id is missing

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

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

422 type isn't allowed

{
  "message": "The selected type is invalid.",
  "errors": {
    "type": [
      "The selected type is invalid."
    ]
  }
}

Status	Meaning
`200`	The blocks, or `[]`.
`401`	The token is missing, expired or invalid.
`422`	`company_id` is missing, doesn't exist or is outside your tree, or `type` isn't allowed.
`500`	Unexpected server error.

Example request

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

Updated 17 days ago

Did this page help you?