Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HackMD User Folders API

Operations related to a user's personal folders.

HackMD User Folders API is one of 8 APIs that HackMD publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User Folders. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

This API exposes 7 operations across 3 paths, and defines 8 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against a single base URL, /v1.

7 operations 3 paths 8 schemas 1 DELETE3 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.hackmd.io/v1
Authentication
HTTP Bearer
License
UNLICENSED
Resource Areas
1

Authentication & Security 1

HackMD User Folders API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (token).

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

User Folders 7

Operations related to a user's personal folders.

GET
/folders
List all folders in the current user's workspace
ListFolders → 200
POST
/folders
Create a new folder in the current user's workspace
CreateFolder body → 201
GET
/folders/folder-order
Get your personal folder ordering for this workspace (parent folder id or root → ordered child folder ids). Uses the same folder UUIDs as (not internal Yjs clientIds).
GetFolderOrder → 200
PUT
/folders/folder-order
Replace your personal folder ordering for this workspace.
UpdateFolderOrder body → 204
GET
/folders/{folderId}
Get a single folder in the current user's workspace
GetFolder 1 param → 200
PATCH
/folders/{folderId}
Update a folder in the current user's workspace
UpdateFolder 1 param body → 202
DELETE
/folders/{folderId}
Delete a folder in the current user's workspace
DeleteFolder 1 param → 204

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ApiFolder (8 properties), UpdateUserFolderBody (5 properties), CreateUserFolderBody (5 properties), UpdateFolderOrderBody (1 property). Each schema is shown below with its type and property counts.

FolderIconCodepoint
string
Folder icon as an emoji unified codepoint string. Examples: 1F525 (🔥), 2764-FE0F (❤️).
FolderName
string
Folder name.
FolderColorHex
string
Folder display color in hexadecimal format. Accepts RGB, RGBA, RRGGBB, or RRGGBBAA.
CreateUserFolderBody
object
5 properties
UpdateFolderOrderBody
object
1 property 1 required
ApiFolderOrder
object
Per-user display order of folders: maps each parent folder id (or root) to an ordered list of child folder ids. Keys and values use the same UUIDs as {@link Ap…
UpdateUserFolderBody
object
5 properties
ApiFolder
object
8 properties 8 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hackmd-user-folders-api-openapi.yml Raw ↑

Other APIs HackMD publishes across the network.

HackMD History API
HackMD Profile API
HackMD Team Folders API
HackMD Team Notes API
HackMD Teams API
HackMD Trash API
HackMD User Notes API