📚

faqs

Frequently Asked Question entry with question, answer, category, display order, helpful votes, view count, and timestamps. Used for help centers, knowledge bases, and customer support documentation.

🎯 Request Builder

https://api.mockly.codes/faqs?page=1&limit=10&count=10
📡

Configure your request and click Send Request to see the response here.

Endpoints

GET/faqs

Get a collection of faqs

Alternative: /reference/faqs
GET/faqs/:id

Get a single faq by ID

Alternative: /reference/faqs/:id
GET/faqs/meta

Get resource metadata and schema

Alternative: /reference/faqs/meta
🔍

How to Use Search

The search feature allows you to filter results by searching for text across all or specific fields. Choose between ?q= or ?search= parameter names.

1. Basic Search

Search across all text fields:

Basic Search
GET https://api.mockly.codes/faqs?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/faqs?q=laptop&search_fields=name,description

💡 Pro Tips

  • •Search is case-insensitive and performs partial matching
  • •Without search_fields, all text fields are searched
  • •Combine with pagination to handle large result sets efficiently

Code Examples

JavaScript

Fetch Collection
// Get 10 faqs
fetch('https://api.mockly.codes/faqs?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

response = requests.get(
    'https://api.mockly.codes/faqs?count=10'
)
data = response.json()

cURL

Command Line
curl "https://api.mockly.codes/faqs?count=10"

Bypass Cache

Get Fresh Data
fetch('https://api.mockly.codes/faqs?nocache=true')

Schema Properties

idinteger

Unique identifier for the FAQ entry

Gen:random_int
questionstring

The frequently asked question

Gen:sentence
answerstring

Answer or solution to the question

Gen:paragraph
categorystring

FAQ category (e.g., Getting Started, Billing, Technical, Account)

Gen:faq_category
orderinteger

Display order or sort position in the FAQ list

Gen:random_int
helpful_countinteger

Number of users who found this FAQ helpful

Gen:random_int
viewsinteger

Total number of times this FAQ has been viewed

Gen:random_int
created_atstring

Timestamp when the FAQ was created

Gen:past_datedate-time
updated_atstring

Timestamp when the FAQ was last updated

Gen:past_datedate-time

Query Parameters

countinteger

Number of items to return (default: 10, max: 100)

seedinteger

Seed for reproducible data generation

nocacheboolean

Bypass cache and generate fresh data on every request