GetCampaign

GET

/api/v1/campaigns/{campaignId}

Path Parameters

`campaignId`
Required
string

Query Parameters

`clientKey`string

`organizationId`string

curl -X GET "<API_URL>/api/v1/campaigns/string?clientKey=string&organizationId=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"
  }
}

Path Parameters

campaignIdRequiredstring

Query Parameters

clientKeystring

organizationIdstring

Response

`campaignId`
Required
string

`clientKey`string

`organizationId`string