Skip to main content
GET
/
api
/
Communication
/
ByCampaign
/
{campaignId}
Get Communications for a Campaign
curl --request GET \
  --url https://api.virtuoussoftware.com/api/Communication/ByCampaign/{campaignId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string
required

(Required) The campaign identifier.

Query Parameters

filter
string

The filter.

sortBy
string

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

descending
string

The direction to be sorted.

skip
string

The number of records to skip. Default = 0.

take
string

The number of records to take. Default = 10.

Response

200 - application/json

OK

list
object[]
total
string
Last modified on June 5, 2026