Search API — Full-Text FAQ Search

Full-text search across FAQ questions via the TheFAQApp API. Typo-tolerant, weighted results with highlighting and relevance scoring.

Full-text search across questions

Search questions

Authorization

BearerAuth

AuthorizationBearer <token>

API key authentication. Get your key from the dashboard under Settings > API Keys.

In: header

Path Parameters

organizationSlug*string

Query Parameters

q*string

Search query (required)

Length1 <= length

page?|

limit?|

Rangevalue <= 50

category?string

Filter by category slug

Response Body

`application/json`

curl -X GET "https://app.thefaq.app/api/v1/string/search?q=how+to"

{
  "data": {
    "query": "string",
    "results": [
      {
        "id": "string",
        "question": "string",
        "answer": "string",
        "slug": "string",
        "category": {
          "id": "string",
          "name": "string",
          "slug": "string"
        },
        "tags": [
          "string"
        ],
        "views": 0,
        "createdAt": "2019-08-24T14:15:22Z"
      }
    ]
  },
  "meta": {
    "pagination": {
      "page": 0,
      "limit": 0,
      "total": 0,
      "pages": 0
    }
  }
}

Empty