getFolder
Returns full detail for a specified folder.
Input parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| FolderID | numeric - ID code | Yes | The identifier of the folder to retrieve. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getFolder?auth=$authHash&FolderID=$FolderID"Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
| Parameter | Type | Description |
|---|---|---|
| Status | codes - set values | "Success" when the call completes; "Error" when the call fails. |
| Data | text - heading | JSON array heading that precedes report data output. |
| DeletedBy | string (max) | The name of the agent who deleted the item. <None> or null value indicates that the <resource> was not deleted. |
| AccountID | numeric - ID code | Bold360 product account. |
| Updated | date - ISO / UTC | Date and time when the <event/record> was most recently modified. |
| FolderID | numeric | The ID of the folder. |
| ParentFolderID | numeric - ID code | The system-assigned ID of the folder's parent. |
| Name | string(30) | The name of the folder as defined in the system. |
| Created | date - ISO/UTC | Date and time when the target resource was created. |
| FolderFlags | code - set values | The following flags can be applied on folders:
|
| Deleted | date - ISO / UTC | Date and time when the item was deleted. The value is null if the item was not deleted. |
| FolderType | integer | Related data item type:
|
Sample code
{
"Status": "success",
"Data": {
"DeletedBy": null,
"AccountID": "447307236667849894",
"Updated": "2019-09-25T13:57:07.833Z",
"FolderID": "445200405554148981",
"ParentFolderID": null,
"Name": "Tweets",
"Created": "2019-09-25T13:57:07.833Z",
"FolderFlags": "7",
"Deleted": null,
"FolderType": 82
}