Sign in
Folders

List folder children

Returns the direct child folders of a folder. Subfolders the caller cannot access — but manages the parent of — are returned as opaque ids in restrictedFolderIds.

get/folders/{folderId}/children

Path parameters

folderIdstring required

ID of the folder.

Query parameters

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 child folders.

hrefstring url

API link to these results.

nextPageTokenstring

If specified, an opaque token used to fetch the next page of results.

nextPageLinkstring url

If specified, a link that can be used to fetch the next page of results.

Example response

{
  "items": [
    {
      "id": "fl-1Ab234",
      "name": "Projects",
      "browserLink": "https://docs.superhuman.com/folders/fl-1Ab234",
      "description": "A collection of project docs.",
      "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/fl-1Ab234/children",
  "nextPageToken": "eyJsaW1pd",
  "nextPageLink": "https://docs.superhuman.com/apis/v1/folders/fl-1Ab234/children?pageToken=xyz"
}

Changes

Changed in 1 of the 5 revisions of this API.1