Query Campaigns | Virtuous Developer Documentation

curl -X POST "https://api.virtuoussoftware.com/api/Campaign/Query?skip=1&take=1" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "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>"
}'

{
  "list": [
    {
      "campaignId": "<integer>",
      "name": "<string>",
      "startDateTimeUtc": "<dateTime>",
      "endDateTimeUtc": "<dateTime>",
      "givingGoal": "<double>",
      "newGiverGoal": "<integer>",
      "totalGiftGoal": "<integer>",
      "isArchived": "<boolean>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>"
    },
    {
      "campaignId": "<integer>",
      "name": "<string>",
      "startDateTimeUtc": "<dateTime>",
      "endDateTimeUtc": "<dateTime>",
      "givingGoal": "<double>",
      "newGiverGoal": "<integer>",
      "totalGiftGoal": "<integer>",
      "isArchived": "<boolean>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>"
    }
  ],
  "total": "<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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10. Max is 1000.

Request

This endpoint expects an object.

groupslist of objectsOptional

sortBystringOptional

descendingstringOptional

Response

listlist of objectsOptional

totalstringOptional

Errors

400

Bad Request Error