---
title: "Get Properties"
method: GET
path: "/definitions/properties"
---

# Get Properties

`GET /definitions/properties`

## Query parameters

- `event_names[]` string[], nullable
- `scopes[]` EventPropertyScope[], nullable
- `datasource_id[]` integer[], nullable
- `pixel_id[]` integer[], nullable
- `derivedOnly` boolean

## Headers

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

## Cookies

- `session_id` string, nullable

## Response `200`

Successful Response

- EventPropertyDefinition[]
  - `scope` 'event' | 'profile' | 'session' | 'product', required
  - `property_name` 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'
  - `type` 'string' | 'numeric' | 'boolean' | 'list_of_strings', required
  - `title` string, nullable
  - `description` string, nullable
  - `suggested_event_name` string, nullable
  - `icon` CustomIcon
    - `icon` string, required
    - `color` 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)