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

Operations to retrieve user profile information.

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

Tagged areas include Profile. 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 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

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

1 operations 1 paths 3 schemas 1 GET

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

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Profile 1

Operations to retrieve user profile information.

GET
/me
Get the current user's profile
GetCurrentUser → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Team (9 properties), User (8 properties). Each schema is shown below with its type and property counts.

TeamVisibilityType
string
User
object
8 properties 7 required
Team
object
9 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hackmd-profile-api-openapi.yml Raw ↑

Other APIs HackMD publishes across the network.

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