How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HackMD User Notes API

Operations related to a user's personal notes.

HackMD User Notes 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 Notes. 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 6 operations across 3 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

6 operations 3 paths 10 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 Notes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (token).

Paths & Operations 6

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

User Notes 6

Operations related to a user's personal notes.

GET
/notes
List notes
ListNotes → 200
POST
/notes
Create note
CreateNote body → 201207
GET
/notes/{noteId}
Get note
GetNote 1 param → 200
DELETE
/notes/{noteId}
Delete note
DeleteNote 1 param → 204
PATCH
/notes/{noteId}
Update note
UpdateNote 1 param body → 202
POST
/notes/{noteId}/images
Upload note image
UploadNoteImage 1 param body → 201400401403413415422429

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are NoteType (19 properties), Pick_FolderAttributes.id-or-name-or-icon-or-color-or-parentId-or-clientId_ (6 properties), SimpleUserProfile (4 properties), NoteImageUploadResponse (1 property). Each schema is shown below with its type and property counts.

Pick_FolderAttributes.id-or-name-or-icon-or-color-or-parentId-or-clientId_
object
From T, pick a set of properties whose keys are in the union K
6 properties 6 required
CommentPermissionType
string
NotePublishType
string
FolderPath
NoteType
object
19 properties 18 required
Partial_NoteFeatureValidPermissionRecordType_
object
Make all properties in T optional
NotePermissionRole
string
NoteImageUploadResponse
object
1 property 1 required
SuggestEditPermissionType
string
SimpleUserProfile
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hackmd-user-notes-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 Folders API
Where this information came from

This is an independent, third-party profile of HackMD User Notes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.