API DocsRESTCampaign service

GetCampaign

Retrieve a campaign.

GET
/v1/organizations/{organizationId}/campaigns/{clientKey}

Path Parameters

organizationId
Required
string

clientKey
Required
string

Query Parameters

campaignIdstring

curl -X GET "<API_URL>/v1/organizations/string/campaigns/string?campaignId=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "campaign": {
    "campaignId": "string",
    "organizationId": "string",
    "clientKey": "string",
    "name": "string",
    "description": "string",
    "createdByUserId": "string",
    "modifiedByUserId": "string",
    "createdDate": "2019-08-24T14:15:22Z",
    "modifiedDate": "2019-08-24T14:15:22Z",
    "archivedDate": "2019-08-24T14:15:22Z",
    "tags": [
      {
        "tagId": "string",
        "name": "string"
      }
    ],
    "reports": [
      {
        "reportId": "string",
        "reportName": "string",
        "numAnnotations": 0,
        "numPassedRules": 0,
        "numAcceptedRules": 0,
        "numFailedRules": 0,
        "numOpenRules": 0
      }
    ],
    "createdFromCampaignId": "string"
  }
}