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

# Retrieve a Rule

> Use this endpoint to retrieve a rule by its unique identifier.



## OpenAPI

````yaml /en/openapi/v3-current/tracer.yaml get /v1/rules/{id}
openapi: 3.1.0
info:
  title: Tracer API
  description: >-
    Complete API reference for Tracer services including transaction validation,
    rules management, spending limits, and audit events for SOX/GLBA compliance.
  version: 1.0.0
servers:
  - url: https://tracer.lerian.io
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Health API
    description: >-
      Health check endpoints for liveness and readiness probes. These endpoints
      do not require authentication.
  - name: Validations API
    description: >-
      Transaction validation endpoints. Performance target is under 80ms (p99).
      Validations are not idempotent.
  - name: Rules API
    description: >-
      Validation rule management endpoints. Rules use CEL (Common Expression
      Language) expressions.
  - name: Limits API
    description: >-
      Spending limit management endpoints. Limits control transaction amounts by
      scope and period.
  - name: Audit Events API
    description: >-
      Audit trail endpoints for SOX/GLBA compliance. All validation decisions
      and configuration changes are recorded.
paths:
  /v1/rules/{id}:
    get:
      tags:
        - Rules API
      summary: Retrieve a Rule
      description: Use this endpoint to retrieve a rule by its unique identifier.
      operationId: getRule
      parameters:
        - $ref: '#/components/parameters/RuleId'
        - $ref: '#/components/parameters/ContentType'
        - $ref: '#/components/parameters/XApiKey'
        - $ref: '#/components/parameters/XRequestId'
      responses:
        '200':
          description: >-
            Indicates that the request was successful and the response contains
            the expected data.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
        '400':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0007:
                  $ref: '#/components/examples/Error0007'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                ErrorUnauthenticated:
                  $ref: '#/components/examples/ErrorUnauthenticated'
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0100:
                  $ref: '#/components/examples/Error0100'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorFormat'
              examples:
                Error0004:
                  $ref: '#/components/examples/Error0004'
components:
  parameters:
    RuleId:
      name: id
      in: path
      description: >-
        The unique identifier of the rule that you want to retrieve, update or
        delete.
      required: true
      example: 019c96a0-1071-7a0d-9916-a831221de252
      schema:
        type: string
        format: uuid
    ContentType:
      name: Content-Type
      in: header
      description: The type of media of the resource. Must be `application/json`.
      required: true
      example: application/json
      schema:
        type: string
    XApiKey:
      name: X-API-Key
      in: header
      description: >-
        The API Key for authentication. **This header is required for all
        endpoints except health checks**.
      required: true
      schema:
        type: string
    XRequestId:
      name: X-Request-Id
      in: header
      description: A unique identifier used to trace and track each request.
      required: false
      example: 019c96a0-10ce-75fc-a273-dc799079a99c
      schema:
        type: string
        format: uuid
  schemas:
    Rule:
      type: object
      description: Validation rule.
      properties:
        ruleId:
          type: string
          format: uuid
          description: Unique identifier for the rule.
        name:
          type: string
          description: Human-readable rule name (globally unique).
          maxLength: 255
        description:
          type: string
          description: Rule purpose and logic explanation.
          maxLength: 1000
        expression:
          type: string
          description: CEL expression that must evaluate to boolean.
          maxLength: 5000
        action:
          type: string
          enum:
            - ALLOW
            - DENY
            - REVIEW
          description: Action taken when rule expression evaluates to true.
        scopes:
          type: array
          items:
            $ref: '#/components/schemas/Scope'
          description: Scopes that determine which transactions this rule applies to.
        status:
          type: string
          enum:
            - DRAFT
            - ACTIVE
            - INACTIVE
            - DELETED
          description: Rule lifecycle status.
        createdAt:
          type: string
          format: date-time
          description: When the rule was created.
        updatedAt:
          type: string
          format: date-time
          description: When the rule was last modified.
        activatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When rule was last activated (null if never activated).
        deactivatedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When rule was last deactivated (null if never deactivated).
        deletedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: When rule was deleted (null if not deleted).
    ErrorFormat:
      type: object
      description: The response message error.
      required:
        - code
        - title
        - message
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
        fields:
          type: object
          additionalProperties: true
          description: Additional information about the fields that caused the error.
    Scope:
      type: object
      description: Scope definition for rules and limits. At least one field must be set.
      properties:
        segmentId:
          type: string
          format: uuid
          description: Apply to transactions from this segment.
        portfolioId:
          type: string
          format: uuid
          description: Apply to transactions from this portfolio.
        accountId:
          type: string
          format: uuid
          description: Apply to transactions from this specific account.
        merchantId:
          type: string
          format: uuid
          description: Apply to transactions to this specific merchant.
        transactionType:
          type: string
          enum:
            - CARD
            - WIRE
            - PIX
            - CRYPTO
          description: Apply to this transaction type only.
        subType:
          type: string
          maxLength: 50
          description: Apply to this transaction subType only.
  examples:
    Error0007:
      summary: Invalid Path Parameter
      value:
        code: TRC-0007
        title: Invalid Path Parameter
        message: >-
          The provided ID is not a valid UUID format. Please verify the ID and
          try again.
    ErrorUnauthenticated:
      summary: Unauthorized
      value:
        code: Unauthenticated
        title: Unauthorized
        message: >-
          API Key missing or invalid. Provide a valid API Key in the X-API-Key
          header.
    Error0100:
      summary: Rule Not Found
      value:
        code: TRC-0100
        title: Rule Not Found
        message: >-
          The requested rule does not exist. Please verify the rule ID and try
          again.
    Error0004:
      summary: Internal Server Error
      value:
        code: TRC-0004
        title: Internal Server Error
        message: >-
          An unexpected error occurred. Please try again later or contact
          support if the issue persists.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API Key authentication. Used by single-tenant deployments
        (`MULTI_TENANT_ENABLED=false`). Sent on every `/v1/*` request.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT bearer authentication. Used by multi-tenant deployments
        (`MULTI_TENANT_ENABLED=true`). The JWT is issued by Access Manager and
        must carry the `tenantId` claim — Tracer resolves the tenant from the
        token, not from any header or body field.

````