---
title: "The workspace's UTM convention"
method: GET
path: "/api/v1/rules/convention"
tags: ["rules"]
---

# The workspace's UTM convention

`GET /api/v1/rules/convention`

## Request

- Base URL: `https://app.utmkit.co`
- URL: `https://app.utmkit.co/api/v1/rules/convention`
- Auth: HTTP bearer

Requires a token with the `rules:read` permission.

## Response `200`

Convention

- Convention
  - `casing` string
  - `mode` 'block' | 'warn'
  - `required_parameters` string[]
  - `separator` string

---

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