NGngpvan

/campaigns/{campaignId}

Changed on

Get an existing Campaign by ID

get/campaigns/{campaignId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/campaigns/{campaignId}
  • Auth
    HTTP basic

Path parameters

campaignIdinteger required

Unique identifier of an existing Campaign

Query parameters

$expandstring

The only valid $expand section is contents

Response

200

campaignIdinteger
namestring
campaignDisplayNamestring
statusstring

Example response

{
  "campaignId": 7919,
  "name": "Increase the Minimum Wage",
  "campaignType": {
    "campaignTypeId": 1312,
    "name": "Advocacy"
  },
  "campaignDisplayName": "Advocacy: Increase the Minimum Wage",
  "status": "Active",
  "contents": [
    {
      "contentId": 5328,
      "contentType": {
        "contentTypeId": 1861,
        "name": "Literature"
      },
      "name": "Pro Minimum Wage",
      "shortName": "Pro Wage",
      "displayName": "Literature: Pro Minimum Wage",
      "description": "This is a lit piece encouraging minimum wage increases",
      "disposition": "Positive"
    }
  ]
}

Changes