Query Campaigns
POST {{baseUrl}}/api/Campaign/Query?skip=<integer>&take=<integer>
To see which options can be sent, use the {M:Virtuous.WebApi.Controllers.CampaignController.QueryOptions} 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>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"list":[{"campaignId":"\u003cinteger\u003e","name":"\u003cstring\u003e","startDateTimeUtc":"\u003cdateTime\u003e","endDateTimeUtc":"\u003cdateTime\u003e","givingGoal":"\u003cdouble\u003e","newGiverGoal":"\u003cinteger\u003e","totalGiftGoal":"\u003cinteger\u003e","isArchived":"\u003cboolean\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e"},{"campaignId":"\u003cinteger\u003e","name":"\u003cstring\u003e","startDateTimeUtc":"\u003cdateTime\u003e","endDateTimeUtc":"\u003cdateTime\u003e","givingGoal":"\u003cdouble\u003e","newGiverGoal":"\u003cinteger\u003e","totalGiftGoal":"\u003cinteger\u003e","isArchived":"\u003cboolean\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e"}],"total":"\u003cinteger\u003e"}