HackMD

HackMD History API

Operations related to user's note history.

Documentation GitHub OpenAPI

Operations 1

GET /history Get history #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/hackmd:hackmd-history-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: HackMD Open History API
  version: 1.0.0
  description: HackMD OpenAPI
  license:
    name: UNLICENSED
  contact:
    name: HackMD Team
    email: support@hackmd.io
servers:
- url: /v1
  description: API Server
tags:
- name: History
  description: Operations related to user's note history.
paths:
  /history:
    get:
      operationId: GetHistory
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserHistory'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiRequestErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '429':
          description: Rate limit or workspace quota exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiRateLimitErrorResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiServerErrorResponse'
      description: Get note history for the current user
      tags:
      - History
      security:
      - token: []
      parameters:
      - description: The maximum number of history items to return.
        in: query
        name: limit
        required: false
        schema:
          format: double
          type: number
      summary: Get history
      x-summary-source: derived
components:
  schemas:
    ApiErrorResponse:
      properties:
        error:
          type: string
      required:
      - error
      type: object
      additionalProperties: false
    SimpleUserProfile:
      properties:
        name:
          type: string
        userPath:
          type: string
        photo:
          type: string
        biography:
          type:
          - string
          - 'null'
      required:
      - name
      - userPath
      - photo
      - biography
      type: object
      additionalProperties: false
    ApiRequestErrorResponse:
      properties:
        message:
          type: string
      required:
      - message
      type: object
      additionalProperties: false
    ApiRateLimitErrorResponse:
      anyOf:
      - $ref: '#/components/schemas/ApiErrorResponse'
      - $ref: '#/components/schemas/ApiQuotaErrorResponse'
    GetUserHistory:
      items:
        $ref: '#/components/schemas/Note'
      type: array
    ApiQuotaErrorResponse:
      properties:
        error:
          properties:
            upgradeUrl:
              type: string
            helpUrl:
              type: string
            message:
              type: string
            code:
              type: string
              enum:
              - quota_exceeded
          required:
          - upgradeUrl
          - helpUrl
          - message
          - code
          type: object
      required:
      - error
      type: object
      additionalProperties: false
    FolderPath:
      properties:
        id:
          type: string
        name:
          type: string
        icon:
          type:
          - string
          - 'null'
        color:
          type:
          - string
          - 'null'
        parentId:
          type:
          - string
          - 'null'
        clientId:
          type: string
      required:
      - id
      - name
      - icon
      - color
      - parentId
      - clientId
      type: object
      additionalProperties: false
    NotePermissionRole:
      enum:
      - owner
      - signed_in
      - guest
      type: string
    ApiServerErrorResponse:
      anyOf:
      - $ref: '#/components/schemas/ApiErrorResponse'
      - $ref: '#/components/schemas/ApiRequestErrorResponse'
    Note:
      properties:
        folderPaths:
          items:
            $ref: '#/components/schemas/FolderPath'
          type: array
        writePermission:
          $ref: '#/components/schemas/NotePermissionRole'
        readPermission:
          $ref: '#/components/schemas/NotePermissionRole'
        shortId:
          type: string
        publishLink:
          type: string
        permalink:
          type:
          - string
          - 'null'
        teamPath:
          type:
          - string
          - 'null'
        userPath:
          type:
          - string
          - 'null'
        publishedAt:
          type:
          - number
          - 'null'
          format: double
        publishType:
          $ref: '#/components/schemas/NotePublishType'
        lastChangeUser:
          allOf:
          - $ref: '#/components/schemas/SimpleUserProfile'
        tagsUpdatedAt:
          type:
          - number
          - 'null'
          format: double
        titleUpdatedAt:
          type:
          - number
          - 'null'
          format: double
        createdAt:
          type: number
          format: double
        lastChangedAt:
          type: number
          format: double
        description:
          type: string
        tags:
          items:
            type: string
          type: array
        title:
          type: string
        id:
          type: string
      required:
      - writePermission
      - readPermission
      - shortId
      - publishLink
      - permalink
      - teamPath
      - userPath
      - publishedAt
      - publishType
      - lastChangeUser
      - tagsUpdatedAt
      - titleUpdatedAt
      - createdAt
      - lastChangedAt
      - description
      - tags
      - title
      - id
      type: object
    NotePublishType:
      enum:
      - edit
      - view
      - slide
      - book
      type: string
  securitySchemes:
    token:
      type: http
      scheme: bearer
x-provenance:
  method: harvested
  publisher: HackMD
  source: https://api.hackmd.io/v1/docs/swagger.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)