Folders
List folders
Returns a list of folders the user has access to.
get/folders
Query parameters
workspaceIdstring
Show only folders belonging to the given workspace.
isStarredboolean
If true, returns folders that are starred. If false, returns folders that are not starred. If not specified, returns all folders.
limitinteger
Maximum number of results to return in this query.
pageTokenstring
An opaque token used to fetch the next page of results.
Response
List of folders.
Example response
{
"items": [
{
"id": "fl-1Ab234",
"name": "Projects",
"browserLink": "https://docs.superhuman.com/folders/fl-1Ab234",
"description": "A collection of project docs.",
"icon": {
"browserLink": "https://cdn.coda.io/icons/png/color/icon-32.png"
},
"createdAt": "2018-04-11T00:18:57.946Z",
"canEdit": true,
"workspace": {
"id": "ws-1Ab234",
"organizationId": "org-2Bc456",
"browserLink": "https://docs.superhuman.com/docs?workspaceId=ws-1Ab234",
"name": "My workspace"
}
}
],
"href": "https://docs.superhuman.com/apis/v1/folders?workspaceId=ws-1Ab234",
"nextPageToken": "eyJsaW1pd",
"nextPageLink": "https://docs.superhuman.com/apis/v1/folders?pageToken=xyz"
}