Get testimonials

Overview

Get the testimonials a business displays.

Use this to show them.

You'll need the account's company_id.

Returns the testimonials.

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-testimonials

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.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	array of objects	The testimonials. An empty array `[]` when there are none.
`data[].id`	integer	The block's id.
`data[].company_id`	integer	The account.
`data[].type`	string	`testimonials`.
`data[].content`	string	The HTML content.
`data[].image_url`	string or null	Not used for testimonials; `null`.
`data[].image_direction`	string	Not used for testimonials; `left`.
`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": 21,
        "company_id": 5994,
        "type": "testimonials",
        "content": "<p>Great service, highly recommend!</p>",
        "image_url": null,
        "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

Testimonials: see Response payload.

No testimonials saved:

{
  "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."
    ]
  }
}

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

Example request

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

Updated 17 days ago

Did this page help you?