Get folders
Retrieves the list of folders in a specified project.
API request
To retrieve folders for a project, send a GET request to the following API endpoint:
GET /frs/api/v1/Projects('/''{project_id}'/'')/Folders
Request parameters
- Path parameters
No parameter.
- Query parameters
No parameter.
- Body Parameters
No parameter.
Request headers
The following table describes the headers that you specify in the API request:
Name | Required or Optional | Description |
|---|
IDS-SESSION-ID | Optional | Session token used to authenticate the request. |
Response parameters
The following table describes the parameters that are returned by the API:
Name | Type | Description |
|---|
@odata.context | String | OData context string that identifies the metadata type and expanded navigation properties included in the response. |
value | Array | Array of project resources returned for the current page, ordered by lastUpdatedTime descending. |
value.id | String | Unique identifier for the folder. |
value.name | String | Display name of the folder. |
value.description | String | Text description of the folder. |
value.owner | String | User ID of the folder owner. |
value.createdBy | String | ID of the user who created the folder. |
value.lastUpdatedBy | String | ID of the user who last modified the folder. |
value.lastAccessedBy | String | ID of the user who most recently accessed the folder. |
value.createdTime | String | ISO 8601 timestamp indicating when the folder was created, in UTC format. |
value.lastUpdatedTime | String | ISO 8601 timestamp indicating when the folder was last modified, in UTC format. |
value.lastAccessedTime | String | ISO 8601 timestamp indicating when the folder was last accessed. |
value.expiresBy | String | ISO 8601 timestamp indicating when the folder expires, after which the folder may no longer be accessible. |
value.parentInfo | Array | Array of objects identifying the parent container of the folder, including the parent's ID, name, and type. |
value.documentType | String | Type of document resource. |
value.contentType | String | Storage format of the folder content. |
value.documentState | String | Processing state of the folder, indicating whether the project content is fully available. |
value.aclRule | String | Access control rule applied to the folder, determining the sharing scope. |
value.subcontainerCount | Integer | Number of direct subcontainers within the folder. |
value.customAttributes | Object | Container object holding custom metadata attributes assigned to the folder, grouped into string, number, and date attribute arrays. |
value.repoInfo | Array | Array of objects identifying the repositories. |
value.isSourceControlled | Boolean | Indicates whether the folder is under source control. |
value.checkedOutById | String | ID of the user who has currently checked out the folder. |
Sample request
The following is a sample request based on the values provided:
curl -X GET \
"{base_url}/frs/api/v1/Projects('/''dL4W1gPQXcoetniYJkRkSP'/'')/Folders" \
-H "IDS-SESSION-ID: eyJraW********"
Sample response
- 200 OK
{
"@odata.context": "$metadata#Folders",
"value": [
{
"id": "lHe4cTrmkWBlVVvocAymoA",
"name": "sample",
"description": "sample",
"owner": "aAMp82ldq24j5x0tgG3cEd",
"createdBy": "aAMp82ldq24j5x0tgG3cEd",
"lastUpdatedBy": "aAMp82ldq24j5x0tgG3cEd",
"lastAccessedBy": "aAMp82ldq24j5x0tgG3cEd",
"createdTime": "2025-09-24T09:40:33Z",
"lastUpdatedTime": "2025-09-24T09:40:33Z",
"lastAccessedTime": "2025-09-24T09:40:33Z",
"expiresBy": "2038-01-18T00:00:00Z",
"parentInfo": [
{
"parentId": "7cCn5thwWFLhiZoSosphKL",
"parentName": "REG",
"parentType": "Space"
},
{
"parentId": "3qz0MkS8dL9i1xVmkuydIt",
"parentName": "04864485_freenet_Conversion",
"parentType": "Project"
}
],
"documentType": "Folder",
"contentType": "Binary",
"documentState": "COMPLETE",
"aclRule": "org",
"subcontainerCount": 0,
"customAttributes": {
"stringAttrs": [],
"numberAttrs": [],
"dateAttrs": []
},
"repoInfo": null,
"isSourceControlled": false,
"checkedOutById": null
},
{
"id": "94qLUvvyX3SgC3ipWLVooo",
"name": "DWHREPORT",
"description": "",
"owner": "aAMp82ldq24j5x0tgG3cEd",
"createdBy": "aAMp82ldq24j5x0tgG3cEd",
"lastUpdatedBy": "aAMp82ldq24j5x0tgG3cEd",
"lastAccessedBy": "aAMp82ldq24j5x0tgG3cEd",
"createdTime": "2025-09-24T06:00:53Z",
"lastUpdatedTime": "2025-09-24T06:00:53Z",
"lastAccessedTime": "2025-09-24T06:00:54Z",
"expiresBy": "2038-01-18T00:00:00Z",
"parentInfo": [
{
"parentId": "7cCn5thwWFLhiZoSosphKL",
"parentName": "REG",
"parentType": "Space"
},
{
"parentId": "3qz0MkS8dL9i1xVmkuydIt",
"parentName": "04864485_freenet_Conversion",
"parentType": "Project"
}
],
"documentType": "Folder",
"contentType": "Binary",
"documentState": "COMPLETE",
"aclRule": "org",
"subcontainerCount": 0,
"customAttributes": {
"stringAttrs": [],
"numberAttrs": [],
"dateAttrs": []
},
"repoInfo": null,
"isSourceControlled": false,
"checkedOutById": null
}
]
}