Query Communications
POST {{baseUrl}}/api/Communication/Query?skip=<integer>&take=<integer>
To see which options can be sent, use the Communictation Query Options endpoint.
If requests are timing out, you may be asking for too many items at once. The max take is 1,000.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
skip | string | The number of records to skip. Default = 0. | |
take | string | The number of records to take. Default = 10. Max is 1000. |
Request Body
{"groups"=>[{"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}, {"conditions"=>[{"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}, {"parameter"=>"<string>", "operator"=>"<string>", "value"=>"<string>", "secondaryValue"=>"<string>", "values"=>["<string>", "<string>"]}]}], "sortBy"=>"<string>", "descending"=>"<boolean>"}
RESPONSES
status: OK
{"list":[{"campaignId":"\u003cinteger\u003e","campaignName":"\u003cstring\u003e","channelType":"\u003cstring\u003e","communicationType":"\u003cstring\u003e","startdateTimeUtc":"\u003cdateTime\u003e","givingGoal":"\u003cdecimal\u003e","projectId":"\u003cinteger\u003e","projectCode":"\u003cstring\u003e","projectName":"\u003cstring\u003e","createdDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","lastModifiedDateTimeUtc":"\u003cdatTime\u003e","modifiedByUser":"\u003cstring\u003e"},{"campaignId":"\u003cinteger\u003e","campaignName":"\u003cstring\u003e","channelType":"\u003cstring\u003e","communicationType":"\u003cstring\u003e","startdateTimeUtc":"\u003cdateTime\u003e","givingGoal":"\u003cdecimal\u003e","projectId":"\u003cinteger\u003e","projectCode":"\u003cstring\u003e","projectName":"\u003cstring\u003e","createdDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","lastModifiedDateTimeUtc":"\u003cdatTime\u003e","modifiedByUser":"\u003cstring\u003e"}],"total":"\u003cinteger\u003e"}