Skip to main content
GET
/
document
/
{documentId}
Retrieve a document
curl --request GET \
  --url https://app.myhero.so/document/{documentId} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "_id": "<string>",
    "parentId": "<string>",
    "projectId": "<string>",
    "userId": "<string>",
    "workspaceId": "<string>",
    "name": "<string>",
    "type": "FOLDER",
    "createdAt": 123,
    "updatedAt": 123,
    "description": "<string>",
    "reference": "<string>",
    "isPublished": false,
    "publishedSettings": {
      "publishedById": "<string>",
      "publishedAt": 123,
      "styling": {},
      "domainSlug": "<string>"
    },
    "external": {
      "type": "PDF",
      "resourcePath": "<string>",
      "resourceId": "<string>"
    },
    "icon": {
      "name": "<string>",
      "color": "<string>"
    },
    "emoji": {
      "unified": "<string>",
      "emojiStyle": "<string>"
    },
    "collaborators": [
      {
        "userId": "<string>",
        "role": "owner"
      }
    ],
    "isDeleted": false
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.myhero.so/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves a single document by documentId. Returns the document’s top-level metadata; block content lives under separate endpoints. Returns a 404 shape { _id, isNotFound: true } if the document does not exist or has been soft-deleted.

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

documentId
string
required
Minimum string length: 1

Response

200 response

data
object
required