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 Trash API

Operations for listing and restoring trashed notes.

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

Tagged areas include Trash. 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 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

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

4 operations 4 paths 4 schemas 2 GET2 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 Trash API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (token).

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Trash 4

Operations for listing and restoring trashed notes.

GET
/trash
List trashed notes in your personal workspace (same data as the internal trash API).
ListPersonalTrash → 200
PUT
/trash/batch-restore
Restore multiple notes from trash in one request.
BatchRestore body → 200207404
PUT
/trash/{noteId}/restore
Restore a single note from trash.
RestoreNote 1 param → 204
GET
/teams/{teampath}/trash
List trashed notes in a team workspace (team admin only; same rules as the internal API).
ListTeamTrash 1 param → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ApiTrashNote (9 properties), BatchRestoreTrashBody (1 property). Each schema is shown below with its type and property counts.

ApiTrashNote
object
9 properties 9 required
BatchOperationError
string
TrashBatchOperationResponse
object
BatchRestoreTrashBody
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hackmd-trash-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 User Folders API
HackMD User Notes API