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 Team Notes API

Operations related to notes within a team.

HackMD Team 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 Team 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 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

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

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

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

Paths & Operations 5

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

Team Notes 5

Operations related to notes within a team.

GET
/teams/{teampath}/notes
List all notes for a team
ListTeamNotes 1 param → 200
POST
/teams/{teampath}/notes
Create a new note for a team
CreateTeamNote 1 param body → 201207
GET
/teams/{teampath}/notes/{noteId}
Get a single note for a team
GetTeamNote 2 params → 200
PATCH
/teams/{teampath}/notes/{noteId}
Update a team note
UpdateTeamNote 2 params body → 202
DELETE
/teams/{teampath}/notes/{noteId}
Delete a team note
DeleteTeamNote 2 params → 204

Schemas 9

The contract defines 9 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). Each schema is shown below with its type and property counts.

NoteType
object
19 properties 18 required
FolderPath
SuggestEditPermissionType
string
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
SimpleUserProfile
object
4 properties 4 required
Partial_NoteFeatureValidPermissionRecordType_
object
Make all properties in T optional
NotePermissionRole
string
NotePublishType
string
CommentPermissionType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hackmd-team-notes-api-openapi.yml Raw ↑

Other APIs HackMD publishes across the network.

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