Get FAQ list

Overview

Get the FAQ entries for an account, optionally filtered by type and status.

Prerequisites

• A bearer token (Partner or Account token).
• The required query parameter company_id for the target company.

Base URL

Endpoint

GET /api/v1/account/faq/get

Authentication

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

• Who can call it: Partner or Account tokens.

• The target company is determined by the company_id query parameter and must be an existing company.

• There is no ownership validation, so any authenticated Partner or Account user can retrieve FAQs for any company by ID.

• The token type only affects which company_id values the caller would typically have access to in their own system.

Rate limit

• No rate limit.

Query parameters

• Query: company_id (integer, required) — must be an existing company.
• Query: type (string, optional) — one of landing_page, widget. Filters results when present.
• Query: status (string, optional) — one of active, inactive. Filters results when present.

Response

• data.status (string) — literal "success".
• data.data (array) — list of FAQ records. Each item contains: id, company_id, question, answer, status, type, created_at, updated_at, deleted_at.

200 OK · 200

{
  "data": {
    "status": "success",
    "data": [
      {
        "id": 1,
        "company_id": 34,
        "question": "How long does delivery take?",
        "answer": "Most orders arrive within 3-5 business days.",
        "status": "active",
        "type": "landing_page",
        "created_at": "2026-06-15T10:30:00.000000Z",
        "updated_at": "2026-06-15T10:30:00.000000Z"
      }
    ]
  }
}

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?company_id=123&type=landing_page&status=active" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'