Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry Enterprise Mobility Server 3.5
  3. Contact Service API
  4. Creating and requesting folder and subfolder information
  5. Request all folders and subfolders under the contacts folder

Request all folders and subfolders under the contacts folder

You can retrieve all folders and subfolders that the user created in a user's contact folder. In the following sample code,
BEMS
 retrieves all folders that the user created. 
POST : https://localhost:8443/api/folder/get HTTP/1.1
Content-Type: application/json
X-Good-GD-AuthToken: <
GDAuthToken
>
{
  "MaxNumber": 512,
  "Offset":0
}
If the request is successful,
BEMS
 returns the following response, and the third-party
BlackBerry Dynamics
 apps display the retrieved folder.
{
"LookupInfo": {
   "MoreAvailable": false,
   "NextPageOffset": null,
   "TotalCount": 3,
   "Offset": 1
 },
 "FolderId": 
   { "ChangeKey": "AwAAABYAAAAkmjuXJkcZSLVmVxZy9YrgAAFjhmIy",
     "UniqueId": "AAMkADQyNDc4Mjc1LTMyOTMtNDMzZC1hYmVlLTVm...",
     "FolderName": null,
     "Mailbox": null,
     "XmlElementName": "FolderId",
     "Valid": true,
     "Namespace": "Types"
   },
   "FolderName": "Support folder",
   "ParentFolderId": 
     {
       "ChangeKey": "AQAAAA==",
       "UniqueId": "AAMkADQyNDc4Mjc1LTMyOTMtNDMzZC1hYmVlLTVm...", //Folder “Support folder” is created under this folderId.
       "FolderName": null,
       "Mailbox": null,
       "XmlElementName": "FolderId",
       "Valid": true,
       "Namespace": "Types"
     }
}