Get Communications for a Campaign | Virtuous Developer Documentation

curl -G https://api.virtuoussoftware.com/api/Communication/ByCampaign/campaignId \
     -H "Authorization: Bearer <token>" \
     --data-urlencode filter=<string> \
     --data-urlencode sortBy=<string> \
     --data-urlencode descending=<boolean> \
     -d skip=1 \
     -d take=1

{
  "list": [
    {
      "communicationId": "<integer>",
      "name": "<string>",
      "campaignId": "<integer>",
      "campaignName": "<string>",
      "channelType": "<string>",
      "communicationType": "<string>",
      "startDateTimeUtc": "<dateTime>",
      "givingGoal": "<decimal>",
      "projectId": "<integer>",
      "projectCode": "<string>",
      "projectName": "<string>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>"
    },
    {
      "communicationId": "<integer>",
      "name": "<string>",
      "campaignId": "<integer>",
      "campaignName": "<string>",
      "channelType": "<string>",
      "communicationType": "<string>",
      "startDateTimeUtc": "<dateTime>",
      "givingGoal": "<decimal>",
      "projectId": "<integer>",
      "projectCode": "<string>",
      "projectName": "<string>",
      "createDateTimeUtc": "<dateTime>",
      "createdByUser": "<string>",
      "modifiedDateTimeUtc": "<dateTime>",
      "modifiedByUser": "<string>"
    }
  ],
  "total": "<integer>"
}

Authentication

AuthorizationBearer

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

Path parameters

campaignIdstringRequired

Query parameters

filterstringOptional

The filter.

sortBystringOptional

The field to be sorted. Supported: Id, Name, CreatedDateTime.

descendingstringOptional

The direction to be sorted.

skipintegerOptional

The number of records to skip. Default = 0.

takeintegerOptional

The number of records to take. Default = 10.

Response

listlist of objectsOptional

totalstringOptional