Get FAQs

Overview

Get the business's frequently asked questions.

Use this to display them.

You'll need the account's company_id.

Returns the questions and answers. Filter by type and status, or leave them out to get all of the account's FAQs.

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

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	Only FAQs for this page: `landing_page` or `widget`. Left out: all types.
`status`	query	string	No	Only FAQs with this status: `active` or `inactive`. Left out: both.

Request body

None.

Request payload

None.

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`data`	array of objects	The FAQs. An empty array `[]` when there are none.
`data[].id`	integer	The FAQ's id.
`data[].company_id`	integer	The account.
`data[].type`	string or null	`landing_page`, `widget`, or `null` when saved without a type.
`data[].question`	string	The question.
`data[].answer`	string	The answer.
`data[].status`	string	`active` or `inactive`.
`data[].created_at`	string	When it was saved (ISO 8601).
`data[].updated_at`	string	When it was last changed (ISO 8601).
`data[].deleted_at`	string or null	`null`.

Response payload

{
  "data": {
    "status": "success",
    "data": [
      {
        "id": 1,
        "company_id": 5994,
        "type": "landing_page",
        "question": "How do I leave a review?",
        "answer": "Click the link in the email we sent you.",
        "status": "active",
        "created_at": "2026-06-15T10:30:00.000000Z",
        "updated_at": "2026-06-15T10:30:00.000000Z",
        "deleted_at": null
      }
    ]
  }
}

Examples

Success payload

FAQs: see Response payload.

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

422 Unknown type or status

{
  "message": "The selected type is invalid. (and 1 more error)",
  "errors": {
    "type": [
      "The selected type is invalid."
    ],
    "status": [
      "The selected status is invalid."
    ]
  }
}

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

Example request

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

Updated 17 days ago

Did this page help you?