---
title: "Get a campaign"
method: GET
path: "/campaigns/{campaign_id}"
tags: ["Campaigns"]
---

# Get a campaign

`GET /campaigns/{campaign_id}`

Get campaign details for a specific campaign ID.

## Query parameters

- `with` 'offers' | 'shipping_profiles' | 'primary_campaign_category' | 'secondary_campaign_category'

## Response `200`

OK

- object
  - `campaign_id` integer
  - `campaign_name` string
  - `payment_type_id` 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 — * `1` - Credit Card * `2` - Check * `3` - Google Pay * `4` - Apple Pay * `5` - Cash * `6` - Paypal * `7` - Alternative Payments Sofort * `8` - Alternative Payments POLi * `9` - Alternative Payments SEPA * `10` - ACH * `11` - Afterpay * `12` - Klarna * `13` - SEPA
  - `campaign_active` boolean
  - `campaign_prepaid` boolean
  - `campaign_payment_method_required` boolean
  - `campaign_group_transactions` boolean
  - `campaign_global_js` string, nullable
  - `campaign_global_seo_title` string, nullable
  - `campaign_global_seo_keywords` string, nullable
  - `campaign_global_seo_description` string, nullable
  - `date_created` string, date-time
  - `created_by` integer
  - `date_modified` string, date-time
  - `modified_by` integer
  - `campaign_notes` string, nullable
  - `offers` object[]
    - `offer_id` integer
    - `campaign_offer_id` integer
    - `offer_name` string
    - `offer_code` string, nullable
    - `offer_type_id` integer
    - `offer_price` string
    - `offer_description` string, nullable
    - `offer_global` boolean
    - `offer_url` string, nullable
    - `offer_active` boolean
  - `shipping_profiles` object[]
    - `shipping_profile_id` integer
    - `shipping_profile_name` string
    - `shipping_profile_code` string
    - `carrier_id` null | 1 | 2 | 3 | 4 | 5 | 6 | 8 | 9, nullable — * `1` - USPS * `2` - UPS * `3` - FedEx * `4` - DHL eCommerce * `5` - UPS Mail Innovations * `6` - Canada Post * `8` - Australia Post * `9` - Hermes
    - `shipping_profile_active` boolean
    - `shipping_profile_configs` object[]
      - `shipping_profile_config_id` integer
      - `shipping_profile_config_type_id` 1 | 2 — * `1` - Price * `2` - Weight
      - `shipping_profile_config_min` string, nullable
      - `shipping_profile_config_price` string
  - `primary_campaign_category` object, nullable
    - `campaign_category_id` integer
    - `campaign_category_name` string
  - `secondary_campaign_category` object, nullable
    - `campaign_category_id` integer
    - `campaign_category_name` string

## Other responses

- `401` — Unauthorized response
- `403` — Forbidden response
- `404` — Not Found response
- `500` — Error response

---

[API](https://skmtc.net/vrio/apis/crm-configuration.md) · [All operations](https://skmtc.net/vrio/apis/crm-configuration/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vrio/crm-configuration/revisions/62037010356e/schema)