API Documentation
Folders from Folder GET

get

Folders from Folder GET

Retrieve the list of files/folders contained within the specified folder within a given syncpoint.
Required Scope: Folders, Read

 

URL Parameters

  • Param Name
    Type
    Description
  • SYNCPOINT_ID
    string
    ID associated with the target syncpoint
  • FOLDER_ID
    string
    ID associated with the folder within the syncpoint.
    NOTE: If the folder is being created in the root of a syncpoint, the Syncpoint GET API call must be used to get the RootFolderID and that value should be used here.

Resource URL

https://api.syncplicity.com/ sync/folder_folders.svc/{SYNCPOINT_ID}/folder/{FOLDER_ID}/folders

Query Parameters


Name Values Description
include

Include option, can be comma-separated list of next string values:
'active' - include only active folders (default behaviour)
'deleted' - include deleted folders

limit

Maximum number of items to be loaded

last_folder_id

Last loaded folder ID

uhid

If specified, retrieves the storage endpoint (StorageVault) definitions of the specified user; otherwise, the current user of the application is used.  String User email hash is calculated using the user's email and encoding it using the HMac MD5 algorithm with "6adebb9f-21f9-49d8-95bf-b7007a208cd4" salt


Header Parameters


Name Values Description
Accept
(required)

application/json

AppKey
(required)

Consumer Key of the app from Developer Portal

As-User

A Global Administrator, or eDiscovery Administrator who has been assigned the corresponding privilege, can enter another user’s GUID so that all Content API actions are performed on behalf of that user.
If this header is not used or the Administrator has not been assigned the corresponding privilege, the API works on behalf of the currently authenticated Global or eDiscovery Administrator.

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    (Bad request) - Invalid Folder ID

Working...