📝

documents

Document file or text document with version control. Represents various document types like PDFs, Word documents, technical specifications, or any file-based content.

🎯 Request Builder

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

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

Endpoints

GET/documents

Get a collection of documents

Alternative: /content/documents
GET/documents/:id

Get a single document by ID

Alternative: /content/documents/:id
GET/documents/meta

Get resource metadata and schema

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

2. Search Specific Fields

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

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the document

Gen:random_int
titlestring

Document title or filename

Gen:sentence
typestring

Document type or format (e.g., pdf, docx, markdown, specification, manual)

Gen:word
contentstring

Document content or text (if text-based), or description for file-based documents

Gen:paragraph
authorstring

Full name of the document author or creator

Gen:name
versionstring

Document version number or identifier (e.g., 1.0, 2.1, v3)

Gen:word
file_urlstring

URL or file path where the document file is stored

Gen:urluri
created_atstring

Timestamp when the document was created

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