Team Folders

Get a single folder in a team workspace

get/teams/{teampath}/folders/{folderId}

Request

  • Base URL: https://api.hackmd.io/v1
  • URL: https://api.hackmd.io/v1/teams/{teampath}/folders/{folderId}
  • Auth: HTTP bearer

Path parameters

teampathstring required

The path identifier for the team.

folderIdstring required

The ID of the folder to retrieve.

Response

idstring required
namestring required

Folder name.

descriptionstring nullable required
iconstring required

Folder icon as an emoji unified codepoint string. Examples: 1F525 (🔥), 2764-FE0F (❤️).

colorstring required

Folder display color in hexadecimal format. Accepts #RGB, #RGBA, #RRGGBB, or #RRGGBBAA.

parentFolderIdstring nullable required
createdAtnumber double required
updatedAtnumber double required

Example response

{
  "name": "Engineering",
  "icon": "1F525",
  "color": "#FF6B6B"
}

Changes

No recorded changes to this operation across all 1 revision of this API.