---
title: "List Custom Dimensions"
method: GET
path: "/custom_dimensions"
---

# List Custom Dimensions

`GET /custom_dimensions`

## Request

- Base URL: `https://app.runconverge.com/api`
- URL: `https://app.runconverge.com/api/custom_dimensions`
- Auth: none declared

## Query parameters

- `filters[]` string[], nullable
- `tz` string, nullable
- `start_of_week` 0 | 1

## Headers

- `Authorization` string, nullable
- `X-User-Id` string, nullable
- `X-Browser-Time-Zone` string, nullable

## Cookies

- `session_id` string, nullable

## Response `200`

Successful Response

- ListCustomDimensionsSchema
  - `custom_dimensions` CustomDimensionResponseSchema[], required
    - `name` string, required
    - `icon` CustomIcon
      - `icon` string, required
      - `color` string, nullable
    - `values` CreateCustomDimensionValueSchema[], required
      - `name` string, required
      - `icon` CustomIcon
        - `icon` string, required
        - `color` string, nullable
      - `groups` CustomDimensionValueGroupSchema[], required
        - `filters` union[]
          - union
            - EventPropertyFilter
              - …
            - EventSourceFilter
              - …
            - AdPlatformPropertyFilter
              - …
            - AdPlatformSourceFilter
              - …
            - TouchpointFilter
              - …
            - CustomDimensionFilter
              - …
            - AdPropertiesFilter
              - …
        - `sources` Source[], required
          - `datasource_id` integer, nullable
          - `pixel_id` integer, nullable
          - `ad_platform_id` integer, nullable
        - `type` 'event' | 'ad_platform', required
    - `id` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, 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

## Changes

- **2026-10-13** `118b0bdc2a6a`: 1 breaking, 1 info
  - added `#/components/schemas/ProfileCityProperty, #/components/schemas/ProfileStateProperty, #/components/schemas/ProfileCountryCodeProperty` to the `custom_dimensions/items/values/items/groups/items/filters/items/oneOf[subschema #1: EventPropertyFilter]/property_name/anyOf[subschema #2]/` response property `oneOf` list for the response status `200`
  - added `$city, $country_code, $state` discriminator mapping keys to the `custom_dimensions/items/values/items/groups/items/filters/items/oneOf[subschema #1: EventPropertyFilter]/property_name/anyOf[subschema #2]/` response property for the response status `200`
- **2026-10-06** `4454a7fc4327`: 2 warning
  - added the new `adset_status` enum value to the `custom_dimensions/items/values/items/groups/items/filters/items/oneOf[subschema #7: AdPropertiesFilter]/property` response property for the response status `200`
  - added the new `campaign_status` enum value to the `custom_dimensions/items/values/items/groups/items/filters/items/oneOf[subschema #7: AdPropertiesFilter]/property` response property for the response status `200`
- …earlier changes not shown

[Operation history](https://skmtc.dev/runconverge/apis/runconverge-api/changes/custom_dimensions/get.md)

---

[API](https://skmtc.dev/runconverge/apis/runconverge-api.md) - [All operations](https://skmtc.dev/runconverge/apis/runconverge-api/llms.txt) - [OpenAPI document](https://skmtc.dev/runconverge/apis/runconverge-api/revisions/f723e951cc0b?raw)