getAllInvitations
Returns invitations on the account based on the Created date. Results can be filtered and paged.
Input parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
|
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/getAllInvitations?auth=$authHash&FromDate=2020-01-01T00:00:00Z,ToDate=2020-12-31T11:59:59Z"Return values
Parameters are provided in alphabetic order. See Sample code for probable output.
| Parameter | Type | Description |
|---|---|---|
|
Data |
text - heading |
Heading for the returned JSON objects and values. |
|
Truncated |
Boolean |
Whether or not the above JSON array is the complete result set, or if the server limited the returned results. |
|
NextPage |
string |
If the method called supports it, and the data is truncated, the NextPage parameter will contain the necessary information to pass back to the same server method to get the next page of results. |