getTickets
Returns tickets for a folder based on the Created date.
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
FolderID |
numeric - ID code |
Yes |
The identifier of the folder to retrieve data from. |
FromDate |
date - ISO / UTC |
No |
The start date. |
ToDate |
date - ISO / UTC |
No |
The end date. |
NextPage |
string |
No |
Tells the server the next page of data to retrieve. This parameter should be the same value as what was returned in the response field "NextPage" by the previous call. |
Request format
curl "https://api.boldchat.com/aid/$accountID/data/rest/json/v1/getTickets?auth=$authHash&FolderID=$FolderID"
Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
Parameter | Type | Description |
---|---|---|
Data |
text - heading |
Heading for the data section of the return content. |
Truncated |
Boolean |
Whether or not the data returned is the complete result set. |
NextPage |
string |
If the method called supports it, and the data is truncated, the NextPage parameter contains the necessary information to pass back to the same server method to get the next page of results. |