getFolders
Returns folders on an account, optionally by FolderType.
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
FolderType | integer | No | The folder type to query. If omitted, all folders will be returned. See FolderType, below, for a list of types. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getFolders?auth=$authHash&FolderType=$FolderType"
Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
Parameter | Type | Description |
---|---|---|
AccountID | numeric - ID code | Bold360 product account ID. |
CountryCode | code - ISO 3166 | ISO 2-letter country code (e.g. US). |
Data | text - heading | Heading that precedes report data output. |
Deleted | date - ISO / UTC | Date and time when the item was deleted. The value is null if the item was not deleted. |
DeletedBy | string (max) | The name of the agent who deleted the item. <None> or null value indicates that the <resource> was not deleted. |
FolderFlags | code - set values | The following flags can be applied on folders:
|
FolderID | numeric | The ID of the folder. |
FolderType | integer | Related data item type:
|
Name | string(30) | The name of the folder as defined in the system. |
ParentFolderID | numeric - ID code | The system-assigned ID of the folder's parent. |
Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
Truncated | Boolean | TRUE if results were shortened to fit the report, FALSE if full results for the report criteria were returned. If TRUE, you can filter down the results set or contact us to try to find a way to get at the data you are looking for. |
Updated | date - ISO / UTC | Date and time when the <event/record> was most recently modified. |
Sample code
"Status": "success",
"Truncated": false,
"Data": [
{
"FolderID": "99651247260519382",
"Name": "Training",
"FolderType": 7,
"FolderFlags": "7",
"ParentFolderID": "622107834026036383",
"AccountID": "627499986405274345",
"Created": "2016-05-05T14:43:46.257Z",
"Updated": "2016-05-05T14:43:46.257Z",
"Deleted": null,
"DeletedBy": null
},
]