List Folder Children

Lists all the children of the provided folder identifier. The operation is paginated and the number of items returned can be controlled using the limit query parameter. The supported query params are as follows

• complete - Returns detailed response when complete parameter is set true. By default it is false and minimal response will be returned.

• status - To retrieve only soft deleted folder’s children, set status attribute as deleted. To retrieve only active folder’s children, set status attribute as active. Hard deleted folder’s children cannot be retrieved.

• pageSize - Param to control the number of items returned in the response, set pageSize attribute. By default, it is set to 100.

• nextPageToken - To get the next set of items, set nextPageToken attribute with the value from the previous response.

Prerequisites

• A folder should be created. To know more about creating a folder refer here

Request

GET {baseUrl}/spaces/{spaceId}/folders/{folderId}/children

• Headers:

  • Authorization: Bearer {tid token}

Response

Example response:

{
    "items": [
        {
          "id": "0b36a1e6-d895-4452-b55c-b3bbb9310d62",
          "name": "My File",
          "type": "FILE",
          "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
          "version": "1.0",
          "createdAt": "2023-03-19T11:00:00Z",
          "updatedAt": "2024-03-19T11:00:00Z",
          "createdByTrn": "trn:tid:user:6529d0b3-5856-41ab-88b3-86f7955cddf1",
          "updatedByTrn": "trn:tid:user:7529d0b3-5856-41ab-88b3-86f7955cddf1",
          "deleted": false
        },
        {
          "id": "1ea71c3c-020b-409e-9f4e-12994ce30154",
          "name": "My_folder",
          "type": "FOLDER",
          "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
          "version": "1",
          "createdAt": "2023-05-30T10:30:00Z",
          "updatedAt": "2023-05-30T10:30:00Z",
          "createdByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
          "updatedByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
          "deleted": false
        }
    ],
    "links": {
        "next": {
        "href": "/spaces/_space_id_/folders/_folder_id_/children?nextPageToken=eyJwYXRoXyI6eyJTIjoiL1JTbWJtL3hPUXhrIn0sInJldmlzaW9uIjp7IkIiOiJVY1pVaFlDUVR4V2ZqMzdFaWVZOWdnPT0ifX0"
        }
  }
}

To know more about list children API refer here. For list children by path refer here.