Retrieve a Campaign by Campaign ID

​

Retrieves a campaign.

Path Parameters
  • campaign_id
    Type: string
    required

    search for records with a matching campaign ID

Responses
  • application/json
  • application/json
  • application/json
Request Example for get/campaigns/{campaign_id}
curl '/campaigns/{campaign_id}' \
  --header 'X-Auth-Token: YOUR_SECRET_TOKEN'

{
  "campaign": {
    "xid": "string",
    "name": "string",
    "code_ref": "string",
    "code_count": "string",
    "external_id": "string",
    "offer_id": 1,
    "channel_id": 1,
    "channel_name": "string",
    "pos_offer_code": "string",
    "online_offer_code": "string",
    "activation_date": null,
    "expiration_date": "string",
    "start_display_at": "string",
    "funding_source": "string",
    "eligible_channel_tags": [
      {}
    ],
    "eligible_store_ids": [
      {}
    ],
    "eligible_store_numbers": [
      {}
    ],
    "eligible_storelist_ids": [
      {}
    ],
    "eligible_storelist_numbers": [
      {}
    ],
    "landing_page_image_template_id": "string",
    "description_template_id": "string",
    "description": "string",
    "terms_and_conditions_template_id": "string",
    "terms_and_conditions": "string",
    "security": "string",
    "landing_page_urls": {},
    "allow_return_later": true,
    "redemption_identifier_type": 1,
    "member_required": true,
    "max_redemptions_per_member": "string",
    "dynamic_expiration": "string",
    "sub_audience_id": 1,
    "audience_id": 1,
    "status": "string",
    "redemption_grace_period": null
  },
  "errors": {
    "errors": {}
  }
}

Example response