Get FAQ list

Get the FAQ entries for a company, optionally filtered by type and status.

Auth: Both — authentication bearer token. Target company is taken straight from the company_id query param (validated Must be an existing account). There is no ownership check / partner-tree ownership check, so any authenticated Partner or Account user can read any company's FAQs by id. Role only differs in which company_id the caller would naturally pass.

Rate limit: No rate limit.

Request

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

Response{ data. } envelope. Note the controller passes its own status/data array into successResponse, producing a nested envelope.

  • data.status (string) — literal "success".
  • data.data (array) — list of Faq records. Each item: id, company_id, question, answer, status, type, created_at, updated_at, deleted_at.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Required. Company whose FAQs to fetch.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json