Skip to main content
GET
/
document
/
all
/
{projectId}
List documents in a project
curl --request GET \
  --url https://app.myhero.so/document/all/{projectId} \
  --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.

Lists all documents belonging to projectId. Pass includeCollaborators=true to include per-document collaborator arrays (requires owner or admin role). Pass includeFolders=true to include folder-type documents in the result.

Authorizations

Authorization
string
header
required

HERO personal access token

Path Parameters

projectId
string
required
Minimum string length: 1

Query Parameters

includeCollaborators
enum<string>
Available options:
true,
false
includeFolders
enum<string>
Available options:
true,
false

Response

200 response

data
object[]
required