notes

Personal note or memo with title, content, author, color coding, tags, pin/archive status, and timestamps. Used for note-taking applications, personal organizers, and knowledge management systems.

🎯 Request Builder

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

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

Endpoints

GET/notes

Get a collection of notes

Alternative: /productivity/notes
GET/notes/:id

Get a single note by ID

Alternative: /productivity/notes/:id
GET/notes/meta

Get resource metadata and schema

Alternative: /productivity/notes/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/notes?q=laptop

2. Search Specific Fields

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

Python

Fetch with Requests
import requests

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

cURL

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

Bypass Cache

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

Schema Properties

idinteger

Unique identifier for the note

Gen:random_int
titlestring

Note title or heading

Gen:sentence
contentstring

Note content or body text

Gen:paragraph
author_idinteger

Foreign key reference to the user who created the note

Gen:random_int
authorstring

Full name of the note author

Gen:name
colorstring

Color code or name for visual organization

Gen:color
tagsarray

Array of tags for categorization and search

Gen:tags
pinnedboolean

Whether the note is pinned to the top of the list

Gen:boolean
archivedboolean

Whether the note is archived and hidden from the main view

Gen:boolean
created_atstring

Timestamp when the note was created

Gen:past_datedate-time
updated_atstring

Timestamp when the note was last modified

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