📝

guides

Instructional guide or how-to article providing step-by-step instructions. Contains guide content, category, author, tags, and publication information for knowledge bases and help centers.

🎯 Request Builder

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

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

Endpoints

GET/guides

Get a collection of guides

Alternative: /content/guides
GET/guides/:id

Get a single guide by ID

Alternative: /content/guides/:id
GET/guides/meta

Get resource metadata and schema

Alternative: /content/guides/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/guides?q=laptop

2. Search Specific Fields

Field-Specific Search
GET https://api.mockly.codes/guides?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 guides
fetch('https://api.mockly.codes/guides?count=10')
  .then(res => res.json())
  .then(data => console.log(data));

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the guide

Gen:random_int
titlestring

Title of the guide (e.g., How to Set Up Your Account, Getting Started Guide)

Gen:sentence
descriptionstring

Brief description or overview of what the guide covers

Gen:paragraph
categorystring

Category or topic area the guide belongs to (e.g., Setup, Troubleshooting, Advanced)

Gen:category
authorstring

Full name of the guide author

Gen:name
contentstring

Full guide content with instructions and explanations

Gen:paragraph
tagsarray

Array of tags for categorization and searchability

Gen:tags
published_atstring

Timestamp when the guide was published

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