GETapi.synup.com/api/v4/folder-details
Get details of a folder
This API retrieves detailed information about a specific folder.
Response Includes:
- Folder details (ID, name)
- Parent folder information (if applicable)
- Creation date
Requires an API key. Send it as
Authorization: API <your-key> — see Getting started.Parameters
Query
| Name | Type | Required | Description |
|---|---|---|---|
folderId | string | optional | Unique identifier of the folder |
folderName | string | optional | Name of the folder |
Request
Request
curl -X GET 'https://api.synup.com/api/v4/folder-details?folderId=&folderName=' \
-H 'Authorization: API YOUR_API_KEY' \
-H 'Content-Type: application/json'const res = await fetch('https://api.synup.com/api/v4/folder-details?folderId=&folderName=', {
method: 'GET',
headers: {
Authorization: 'API YOUR_API_KEY',
'Content-Type': 'application/json',
},
});
const data = await res.json();import requests
res = requests.get(
"https://api.synup.com/api/v4/folder-details?folderId=&folderName=",
headers={
"Authorization": "API YOUR_API_KEY",
"Content-Type": "application/json",
},
)
data = res.json()req, _ := http.NewRequest("GET", "https://api.synup.com/api/v4/folder-details?folderId=&folderName=", nil)
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)Responses
| Status | Description |
|---|---|
200 | Successfully retrieved folder details |
Example response (generated from the schema)
{
"data": {
"getFolderDetails": {
"locations": [
{}
],
"folderName": "franchise",
"parentFolderId": "72a9f81d-1c74-44c2-8e7d-7c51787cbc09",
"parentFolderName": "all_franchise",
"createdAt": "2024-04-03 10:29:49 UTC"
}
}
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | object | optional | |
data.getFolderDetails | object | optional | |
data.getFolderDetails.locations | array of object | required | List of locations in the folder |
data.getFolderDetails.folderName | string | required | Name of the folder |
data.getFolderDetails.parentFolderId | string | required | Unique identifier of the parent folder |
data.getFolderDetails.parentFolderName | string | required | Name of the parent folder |
data.getFolderDetails.createdAt | string | required | Creation timestamp of the folder |