List Folder Versions

Retrieves a list of all versions for the provided folder identifier. The response contains a list of the versions for the folder. Each version includes the folder version metadata. The response 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 soft deleted folder’s versions, set status attribute as deleted. To retrieve active folder’s versions, set status attribute as active. Hard deleted folder’s versions 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}/versions

• Headers:

  • Authorization: Bearer {tid token}

Response

Example response:

{
  "items": [
    {
      "createdAt": "2024-03-17T00:00:00Z",
      "createdByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
      "updatedAt": "2024-03-17T00:00:00Z",
      "updatedByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
      "deleted": false,
      "id": "f85bc802-5481-4581-b972-c4652d595ec7",
      "name": "My_folder",
      "type": "FOLDER",
      "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
      "version": "1"
    },
    {
      "createdAt": "2024-03-17T00:00:00Z",
      "createdByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
      "updatedAt": "2024-03-18T00:00:00Z",
      "updatedByTrn": "trn:tid:user:e8f7b97d-831b-4c99-9e13-04dd30f826cc",
      "deleted": false,
      "id": "f85bc802-5481-4581-b972-c4652d595ec7",
      "name": "Rename_folder",
      "type": "FOLDER",
      "spaceId": "f85bc802-5481-4581-b972-c4652d595ec7",
      "version": "2"
    }
  ],
  "links": {
    "next": {
        "href": "/spaces/_space_id_/folders/_folder_id_/versions?nextPageToken=eyJwYXRoXyI6eyJTIjoiL1JTbWJtL3hPUXhrIn0sInJldmlzaW9uIjp7IkIiOiJVY1pVaFlDUVR4V2ZqMzdFaWVZOWdnPT0ifX0"
    }
  }
}

To know more about the List folder versions API refer here. For List folder versions by path refer here.