Get testimonials
Overview
Get the testimonials configured for an account.
Prerequisites
- A bearer token. Callable with Partner and Account tokens.
- The required query parameter
company_id(integer) — must exist in thecompanytable.
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
-
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_idquery param. There is no ownership/partner-tree scoping, so any authenticated Partner or Account user can read any company's testimonials. -
Role only changes which
company_idyou pass.
Rate limit
- No rate limit.
Query parameters
- Query:
company_id(integer, required) — must exist in thecompanytable.
Response
data.status(string) — literal"success".data.data(array) — list of rawRsBlockmodels filtered totype = "testimonials". Each item:id,company_id,type("testimonials"),content,image_url,image_direction,status,created_at,updated_at,deleted_at.
200 OK · 200
200{
"data": {
"status": "success",
"data": [
{
"id": 21,
"company_id": 34,
"type": "testimonials",
"content": "<p>Fantastic service, highly recommended!</p>",
"status": "active"
}
]
}
}422 Validation error · 422
422{
"message": "The company id field is required.",
"errors": {
"company_id": ["The company id field is required."]
}
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
422 | Validation error |
500 | Unexpected server error |
Example request
curl --request GET \
--url "https://production-api.shoutaboutus.com/api/v1/account/faq/get-testimonials?company_id=123" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json'Updated 10 days ago
Did this page help you?
