Bold360 and BoldChat Developer Center

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:
  • 0 - NONE
  • 1 - DISABLE_NEW
  • 2 - DISABLE_RENAME
  • 4 - DISABLE_DELETE
  • 8 - INVISIBLE_PRE_4
  • 16 - CALL
FolderID numeric The ID of the folder.
FolderType integer Related data item type:
  • 2 - Contacts
  • 3 - Tickets
  • 4 - Email
  • 5 - Chats
  • 6 - Visits
  • 7 - Reports
  • 8 - Canned messages for chats
  • 9 - Canned messages for emails
  • 10 - Brandings
  • 11 - Contact user categories
  • 12 - Chat button definitions
  • 13 - Invitation definitions
  • 14 - Chat window definitions
  • 15 - Departments
  • 16 - Email accounts
  • 17 - Agents
  • 18 - Contact user statuses
  • 19 - Website definitions
  • 20 - Chat user categories
  • 21 - Chat user statuses
  • 22 - Email user categories
  • 23 - Email user statuses
  • 24 - Ticket user categories
  • 25 - Ticket user statuses
  • 26 - Customer user categories
  • 27 - Customer user statuses
  • 28 - Permission groups
  • 29 - Chat invitation template variants
  • 30 - Contact custom fields 1
  • 31 - Contact custom fields 2
  • 32 - Chat custom fields 1
  • 33 - Chat custom fields 2
  • 34 - Email custom fields 1
  • 35 - Email custom fields 2
  • 36 - Ticket custom fields 1
  • 37 - Ticket custom fields 2
  • 38 - Customer referrers
  • 39 - Customer entry locations
  • 40 - Conversion codes
  • 41 - Conversions
  • 42 - Call user categories
  • 43 - Call user statuses
  • 44 - Call custom fields 1
  • 45 - Call custom fields 2
  • 48 - Call button definitions
  • 49 - Call window definitions
  • 50 - Calls
  • 51 - Call invitation template variants
  • 55 - External CRMs
  • 57 - Active Assists
  • 58 - Latitude and longitude coordinates
  • 59 - Co-browse bookmarks
  • 60 - Scheduled reports
  • 61 - Email redirects
  • 62 - XMPP clients
  • 65 - Knowledge Bases
  • 66 - Discussions
  • 67 - Languages
  • 73 - SMS
  • 74 - Text receiver
  • 75 - Canned messages for text messages
  • 76 - Text user categories
  • 77 - Text user statuses
  • 78 - Text custom fields 1
  • 79 - Text custom fields 2
  • 80 - Floating chat button definitions
  • 81 - Floating call button definitions
  • 82 - Twitter
  • 83 - Twitter accounts
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
        },
]