cURL
curl --request GET \ --url https://your-sift-api-url.com/api/v1/campaigns/{campaignId} \ --header 'Authorization: Bearer <token>'
{ "campaign": { "campaignId": "<string>", "name": "<string>", "organizationId": "<string>", "clientKey": "<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" } ] } }
Retrieve a campaign.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Bearer <token>
<token>
A successful response.
The response of a call to CampaignService_GetCampaign to retrieve a campaign.
CampaignService_GetCampaign
Show child attributes
Was this page helpful?