> ## Documentation Index
> Fetch the complete documentation index at: https://docs.utmkit.co/llms.txt
> Use this file to discover all available pages before exploring further.

# The workspace's UTM convention

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



## OpenAPI

````yaml /openapi.json get /api/v1/rules/convention
openapi: 3.0.0
info:
  description: >-
    Every request carries `Authorization: Bearer utmk_…`. The token fixes the
    workspace; no request names one. Every operation declares `x-permission`,
    the token permission it requires.
  title: UTM Builder API
  version: '1'
servers:
  - url: https://app.utmkit.co
    variables: {}
security:
  - bearer: []
tags: []
paths:
  /api/v1/rules/convention:
    get:
      tags:
        - rules
      summary: The workspace's UTM convention
      description: Requires a token with the `rules:read` permission.
      operationId: UtmBuilderWeb.API.V1.RulesController.convention
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Convention'
          description: Convention
      callbacks: {}
components:
  schemas:
    Convention:
      properties:
        casing:
          type: string
        mode:
          enum:
            - block
            - warn
          type: string
        required_parameters:
          items:
            type: string
          type: array
        separator:
          type: string
      title: Convention
      type: object
  securitySchemes:
    bearer:
      description: utmk_<lookup><secret>, minted on /tokens
      scheme: bearer
      type: http

````