---
title: "Get Forwarding Destination"
method: GET
path: "/forwarding/{id}"
---

# Get Forwarding Destination

`GET /forwarding/{id}`

## Path parameters

- `id` integer, required

## Headers

- `Authorization` string, nullable
- `X-User-Id` string, nullable

## Cookies

- `session_id` string, nullable

## Response `200`

Successful Response

- ForwardingDestinationResponseSchema
  - `id` integer, required
  - `active` boolean, required
  - `authentication_failure` ForwardingFailure, required
    - `type` 'authentication_error' | 'application_error' | 'parsing_error' | 'connection_error' | 'response_error' | 'unknown_error', required
    - `description` string, required
    - `status_code` integer, nullable
    - `message` string, nullable
  - `name` string, required
  - `description` string, nullable, required
  - `config` union, required
    - DummyForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'dummy'
      - `dummy_value` integer
    - GA4ForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'ga4'
      - `measurement_id` string, required
      - `api_secret` string, nullable
      - `use_sgtm` boolean
      - `user_properties` UserPropertyConfig[]
        - `profile_property` string, required
        - `ga4_property` string, required
      - `ga4_event_properties` Mapping[]
        - `converge` string, required
        - `forward` string, required
      - `ga4_item_properties` Mapping[]
        - `converge` string, required
        - `forward` string, required
      - `internal_converge_data_layer` boolean
      - `set_user_id` boolean
      - `send_serverside_consent` boolean
      - `override_tag_id` string, nullable
      - `debug` boolean
    - FBForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'fb'
      - `pixel_id` string, required
      - `access_token` string, required
      - `test_event_code` string, nullable
      - `domain` string, required
      - `fb_custom_properties` CustomProperty[]
        - `converge_property` string, required
        - `fb_property` string, required
      - `block_external_tracking` boolean
      - `disable_auto_config` boolean
      - `domain_masking` boolean
    - BigQueryForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'bigquery'
      - `project_id` string, required
      - `dataset_id` string, required
      - `table_id` string, required
      - `merged_profiles_table_id` string
      - `private_key` string, required
      - `private_key_id` string, required
      - `client_email` string, required
    - KlaviyoForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'klaviyo'
      - `public_token` string, required
      - `api_key` string
      - `duplicate_browser_server_events` boolean
      - `klaviyo_custom_properties` CustomPropertyConfig[]
        - `converge_property` string, required
        - `klaviyo_property` string, required
    - TikTokForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'tiktok'
      - `pixel_code` string, required
      - `access_token` string, required
      - `test_event_code` string, nullable
      - `default_url` string, required
      - `domain_masking` boolean
    - CriteoForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'criteo'
      - `account_id` string, required
    - GoogleAdsConversionsForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'google_ads_conversions'
      - `tag_id` string, required
      - `internal_converge_data_layer` boolean
      - `google_tag_gateway_path` string, nullable
      - `override_tag_id` string, nullable
      - `use_proxied_script` boolean
    - GoogleFloodlightForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'google_floodlight'
      - `floodlight_config_id` string, required
      - `internal_converge_data_layer` boolean
      - `count_transaction_as_single_conversion` boolean
      - `google_tag_gateway_path` string, nullable
    - GoogleAdsRemarketingForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'google_ads_remarketing'
      - `tag_id` string, required
      - `internal_converge_data_layer` boolean
      - `google_tag_gateway_path` string, nullable
      - `override_tag_id` string, nullable
      - `use_proxied_script` boolean
    - GoogleAdsAPIConversionForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'google_ads_api_conversions'
      - `customer_id` string, required
      - `manager_customer_id` string, required
      - `tag_id` string, required
      - `refresh_token` string, required
      - `internal_converge_data_layer` boolean
      - `access_token` string, nullable
      - `google_tag_gateway_path` string, nullable
      - `override_tag_id` string, nullable
      - `use_proxied_script` boolean
      - `validate_only` boolean
      - `send_captured_consent` boolean
      - `api_version` 'google_ads_api' | 'data_manager_api' — Which upload API a Google Ads conversions connection uses. The two versions need different OAuth scopes, so a connection can't switch between them without re-authing — the value is set when the connection is created (or re-authed) and the forwarder picks the matching code path.
    - PinterestForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'pinterest'
      - `ad_account_id` string, required
      - `tag_id` string, required
      - `access_token` string, required
      - `test` boolean
      - `default_url` string
    - TaboolaForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'taboola'
    - OutbrainForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'outbrain'
    - TwitterForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'twitter'
      - `pixel_id` string, required
    - CustomHtmlForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'custom_html'
      - `setup_html` string, required
      - `event_html` CustomHtmlEventSnippet[]
        - `event_name` string, required
        - `content` string, required
    - ConvertForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'convert'
      - `project_id` string, required
      - `account_id` string, required
    - BingForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'bing'
      - `tag_id` string, required
    - MGIDForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'mgid'
      - `postback_id` string, required
    - RedditForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'reddit'
      - `account_id` string, required
      - `access_token` string, required
      - `refresh_token` string, required
      - `test_mode` boolean
      - `currency` string
    - SnapchatForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'snapchat'
      - `pixel_id` string, required
      - `token` string, required
      - `default_url` string, required
    - AwinForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'awin'
      - `advertiser_id` string, required
      - `custom_parameters` string[]
      - `commission_group_code` string, nullable
      - `test_mode` boolean, nullable
    - PostscriptForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'postscript'
      - `api_token` string, required
    - AppLovinForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'applovin'
      - `event_key` string, required
      - `user_id_property` string, nullable
    - CustomerIOForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'customerio'
      - `api_key` string
    - VibeForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'vibe'
      - `advertiser_id` string, required
    - SegmentForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'segment'
      - `client_write_key` string, required
      - `server_write_key` string, required
      - `segment_event_properties` Mapping[]
        - `converge` string, required
        - `forward` string, required
      - `segment_item_properties` Mapping[]
        - `converge` string, required
        - `forward` string, required
      - `segment_region` 'eu' | 'us'
      - `enable_onetrust_consent_wrapper` boolean
    - OpenAIAdsForwardingConfig
      - `item_id_type` 'variant_id' | 'product_id' | 'sku' | 'default' | 'custom'
      - `item_id_template` string, nullable
      - `conversion_amount` 'gross_revenue' | 'gross' | 'net' | 'net_after_tax' | 'net_after_tax_and_shipping' | 'net_after_shipping' | 'custom'
      - `conversion_amount_property` string, nullable
      - `app` 'openai_ads'
      - `pixel_id` string, required
      - `api_key` string, required
      - `domain` string, required
      - `debug` boolean
  - `filters` ForwardingFilter[], required
    - `event_name` string, required
    - `filter_mode` 'client' | 'server' | 'both'
    - `or_filters` WhereFilter[], required
      - `property` union, required
        - string
        - union
          - RevenueProperty
            - `derived` 'revenue'
          - TaxProperty
            - `derived` 'taxes'
          - DiscountProperty
            - `derived` 'discount'
          - ShippingProperty
            - `derived` 'shipping'
          - NetRevenueAfterTaxProperty
            - `derived` 'net_revenue_after_tax'
          - NetRevenueAfterTaxAndShippingProperty
            - `derived` 'net_revenue_after_tax_and_shipping'
          - ProductIDsProperty
            - `derived` 'product_ids'
          - VariantIDsProperty
            - `derived` 'variant_ids'
          - ProductSKUsProperty
            - `derived` 'product_skus'
          - ProductNamesProperty
            - `derived` 'product_names'
          - ProductBundleIds
            - `derived` 'bundle_ids'
          - ProductBundleNames
            - `derived` 'bundle_names'
          - NumberOfItemsProperty
            - `derived` 'number_of_items'
          - PaymentMethodProperty
            - `derived` 'payment_method'
          - SalesChannelTypeProperty
            - `derived` '$sales_channel_type'
          - URLProperty
            - `derived` '$url'
          - FullURLProperty
            - `derived` 'full_url'
          - ReferrerProperty
            - `derived` '$referrer'
          - LandingURLProperty
            - `derived` 'landing_url'
          - FullLandingURLProperty
            - `derived` 'full_landing_url'
          - LandingURLDomainProperty
            - `derived` 'landing_url_domain'
          - LandingURLPathProperty
            - `derived` 'landing_url_path'
          - TimezoneProperty
            - `derived` '$timezone'
          - LanguageProperty
            - `derived` '$language'
          - TitleProperty
            - `derived` '$title'
          - DeviceBrandProperty
            - `derived` '$device_brand'
          - DeviceModelProperty
            - `derived` '$device_model'
          - DeviceTypeProperty
            - `derived` '$device_type'
          - OSProperty
            - `derived` '$os'
          - BrowserProperty
            - `derived` '$browser'
          - GenderGuessProperty
            - `derived` '$gender_guess'
          - GeoIPCityNameProperty
            - `derived` '$geoip_city_name'
          - GeoIPCountryNameProperty
            - `derived` '$geoip_country_name'
          - GeoIPCountryCodeProperty
            - `derived` '$geoip_country_code'
          - GeoIPRegionNameProperty
            - `derived` '$geoip_region1_name'
          - GeoIPZipCodeProperty
            - `derived` '$geoip_zip_code'
          - IsCustomerProperty
            - `derived` '$is_customer'
          - IsNewVisitorProperty
            - `derived` '$is_new_visitor'
          - UtmSourceMedium
            - `derived` 'utm_source_medium'
          - FullSessionReferrerProperty
            - `derived` 'full_referrer'
          - ProfileIDProperty
            - `derived` 'profile_id'
          - OrderIDProperty
            - `derived` 'order_id'
          - ProductPriceProperty
            - `derived` 'product_price'
          - ProductQuantityProperty
            - `derived` 'product_quantity'
          - ProductRevenueProperty
            - `derived` 'product_revenue'
          - ProductDiscountProperty
            - `derived` 'product_discount'
          - ProductTaxesProperty
            - `derived` 'product_taxes'
          - ProductShippingProperty
            - `derived` 'product_shipping'
          - ProductNetRevenueProperty
            - `derived` 'product_net_revenue'
          - COGSProperty
            - `derived` 'cogs'
          - GrossProfitProperty
            - `derived` 'gross_profit'
          - PaymentProcessingFeeProperty
            - `derived` 'payment_processing_fee'
          - ShippingCostProperty
            - `derived` 'shipping_cost'
          - GrossRevenueProperty
            - `derived` 'gross_revenue'
          - ContributionProfitProperty
            - `derived` 'contribution_profit'
      - `operator` '=' | '>' | '<' | '>=' | '<=' | '!=' | 'includes' | 'includes_any_contains' | 'not_includes' | 'contains' | 'not_contains' | 'is_set' | 'is_not_set', required
      - `value` union, required
        - boolean
        - integer
        - number
        - string
        - string[]
  - `sources` ForwardingSources, required
    - `selected_sources` ForwardingSource[], required
      - `datasource_id` integer, nullable
      - `pixel_id` integer, nullable
  - `event_mappings` DestinationEventMappingSchema[]
    - `id` integer, required
    - `event_name` string, required
    - `destination_event_name` string, required
    - `mode` 'client' | 'server' | 'both'
    - `enabled` boolean
    - `config` object
    - `is_default` boolean
  - `consent_category` 'analytics' | 'marketing', required
  - `consent_mode` 'off' | 'pixel_only' | 'on' | 'strict', required
  - `destination_mode` 'both' | 'server', required — Defines how a forwarding destination should behave BOTH: Pixel will be installed. Events will be processed according to the event mapping. SERVER: No pixel will be installed. Only server-side forwarding will take place, according to the event mapping.
  - `created_at` string, date-time, nullable, required
  - `updated_at` string, date-time, nullable, required
  - `creator` AccountSchema, required
    - `id` integer, required
    - `email` string, required
    - `first_name` string, nullable
    - `last_name` string, nullable
    - `profile_picture_url` string, nullable

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/runconverge/apis/fastapi.md) · [All operations](https://skmtc.dev/runconverge/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/runconverge/fastapi/revisions/1452e350bd1d/schema)