Skip to content
File Service

List Folder Children By Path

Lists all the children of the provided folder path. 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

  • path - The path of the folder for which children need to be listed.

  • 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. 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

Section titled “Prerequisites”
  • A folder should be created. To know more about creating a folder refer here

Request

Section titled “Request”
GET {baseUrl}/spaces/{spaceId}/folders/children?path=/Parent_folder

  • Headers:

    • Authorization: Bearer {tid token}

Response

Section titled “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": "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
        }
    ],
    "nextPageToken": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdGF0dXMiOjEwMCwibmV4dFBhZ2VUb2tlbiI6IjEwMCJ9.eyJzdGF0dX
}

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