Skip to main content
GET
/
api
/
v1
/
campaigns
/
{campaignId}
GetCampaign
curl --request GET \
  --url https://your-sift-api-url.com/api/v1/campaigns/{campaignId} \
  --header 'Authorization: Bearer <token>'
{
  "campaign": {
    "campaignId": "<string>",
    "organizationId": "<string>",
    "clientKey": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdByUserId": "<string>",
    "modifiedByUserId": "<string>",
    "createdDate": "2023-11-07T05:31:56Z",
    "modifiedDate": "2023-11-07T05:31:56Z",
    "archivedDate": "2023-11-07T05:31:56Z",
    "tags": [
      {
        "tagId": "<string>",
        "name": "<string>"
      }
    ],
    "reports": [
      {
        "reportId": "<string>",
        "reportName": "<string>",
        "numAnnotations": 123,
        "numPassedRules": 123,
        "numAcceptedRules": 123,
        "numFailedRules": 123,
        "numOpenRules": 123
      }
    ],
    "createdFromCampaignId": "<string>",
    "metadata": [
      {
        "key": {
          "name": "<string>",
          "type": "METADATA_KEY_TYPE_UNSPECIFIED",
          "archivedDate": "2023-11-07T05:31:56Z"
        },
        "stringValue": "<string>",
        "numberValue": 123,
        "booleanValue": true,
        "archivedDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

campaignId
string
required

Query Parameters

clientKey
string
organizationId
string

Response

A successful response.

The response of a call to CampaignService_GetCampaign to retrieve a campaign.

campaign
object
required