Skip to content
Mobile Joe Docs Dashboard
View Markdown

REST API

List FAQs

GET https://mbj-api.com/v1/faqs

Returns live FAQs sorted by position, with no pagination. Search matches all query words as prefixes against the original title/body, not translations. Localized by Preferred-Languages or Language-Code with original-content fallback. No identity headers required.

Request

curl --include --request GET 'https://mbj-api.com/v1/faqs' \
  --header 'Authorization: Token token=YOUR_API_KEY'

Parameters

Name / locationRequired / typeDetails
search / query No / string Full-text search on title and body Example: "password reset"

Headers: Preferred-Languages, Language-Code. See Headers.

Responses

200 — Successful response

application/json · array of Faq schema

[
  {
    "id": 1,
    "title": "How do I reset my password?",
    "body": "Click the 'Forgot Password' link on the login page...",
    "position": 1,
    "created_at": "2024-01-08T12:00:00Z",
    "updated_at": "2024-01-08T12:00:00Z"
  }
]

Errors: 401, 403, and 429. See Errors.