Skip to content
SynupAPI
Get an API key
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

NameTypeRequiredDescription
folderIdstringoptionalUnique identifier of the folder
folderNamestringoptionalName 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'

Responses

StatusDescription
200Successfully 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

NameTypeRequiredDescription
dataobjectoptional
data.getFolderDetailsobjectoptional
data.getFolderDetails.locationsarray of objectrequiredList of locations in the folder
data.getFolderDetails.folderNamestringrequiredName of the folder
data.getFolderDetails.parentFolderIdstringrequiredUnique identifier of the parent folder
data.getFolderDetails.parentFolderNamestringrequiredName of the parent folder
data.getFolderDetails.createdAtstringrequiredCreation timestamp of the folder