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.0.0, at version 1.0.0.
Requests are made against a single base URL, /v1.
Metadata
The identity and technical contract details declared by the specification.
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.
Operations related to a user's personal notes.
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.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HackMD 7
Other APIs HackMD publishes across the network.