Organizing locations

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

:::info[]

Note: Either folderId or folderName must be provided as a query parameter.

:::

get/folder-details

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/folder-details/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

folderIdstring uuid

Unique identifier of the folder

folderNamestring

Name of the folder

Headers

Authorizationstring

API key for authentication

Response

Successfully retrieved folder details

Example response

{
  "data": {
    "getFolderDetails": {
      "folderName": "franchise",
      "parentFolderId": "72a9f81d-1c74-44c2-8e7d-7c51787cbc09",
      "parentFolderName": "all_franchise",
      "createdAt": "2024-04-03 10:29:49 UTC"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.