> ## 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.

# Get a Catalog Template

> Use this endpoint to retrieve the metadata and parameter JSON Schema of a specific catalog template. If the template references provider configurations, the schema is dynamically enriched with active provider configuration options.



## OpenAPI

````yaml /en/openapi/v3-current/flowker.yaml get /v1/catalog/templates/{id}
openapi: 3.1.0
info:
  description: >-
    Complete API reference for Flowker workflow orchestration services including
    catalog management, workflow definitions, executor configurations, provider
    configurations, and workflow executions.
  title: Flowker API
  version: 1.1.0
servers:
  - url: https://flowker.sandbox.lerian.net
security:
  - ApiKeyAuth: []
tags:
  - name: Health API
    description: Health and version endpoints for monitoring the Flowker service.
  - name: Catalog API
    description: >-
      Browse built-in providers, executors, and triggers available in the
      Flowker catalog.
  - name: Workflows API
    description: >-
      Create, update, activate, deactivate, clone, and delete workflow
      definitions.
  - name: Executions API
    description: Start workflow executions and track their status and results.
  - name: Executor Configurations API
    description: >-
      Configure, test, and manage external executor connections used by workflow
      nodes.
  - name: Provider Configurations API
    description: Configure, test, enable, and disable provider integrations.
  - name: Dashboard API
    description: >-
      Retrieve aggregated summaries of workflows and executions for operational
      dashboards.
  - name: Audit API
    description: Query and verify audit events for compliance and operational visibility.
  - name: Webhooks API
    description: >-
      Receive webhook callbacks from external systems to trigger workflow
      executions.
paths:
  /v1/catalog/templates/{id}:
    get:
      tags:
        - Catalog API
      summary: Get a Catalog Template
      description: >-
        Use this endpoint to retrieve the metadata and parameter JSON Schema of
        a specific catalog template. If the template references provider
        configurations, the schema is dynamically enriched with active provider
        configuration options.
      operationId: getCatalogTemplate
      parameters:
        - description: Unique identifier of the catalog template.
          in: path
          name: id
          required: true
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CatalogTemplateDetail'
          description: >-
            Indicates that the request was successful and the response contains
            the requested data.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommonResponse'
          description: Indicates that the requested resource could not be found.
components:
  schemas:
    CatalogTemplateDetail:
      properties:
        category:
          description: Template category.
          example: payments
          type: string
        description:
          description: Description of the template.
          example: Validate payment with balance check and risk analysis
          type: string
        id:
          description: Unique identifier of the template.
          example: payment-validation
          type: string
        name:
          description: Display name of the template.
          example: Payment Validation
          type: string
        paramSchema:
          description: >-
            JSON Schema defining the expected parameters for this template.
            Dynamically enriched with active provider configuration options when
            applicable.
          example: '{"type":"object","properties":{"midaz_config_id":{"type":"string"}}}'
          type: string
        version:
          description: Template version.
          example: 1.0.0
          type: string
      type: object
    CommonResponse:
      properties:
        code:
          description: Machine-readable error code.
          example: FLK-0200
          type: string
        entityType:
          description: Type of entity related to the error.
          example: executor
          type: string
        err:
          description: Additional error details when available.
          type: object
        message:
          description: Human-readable error message.
          example: Executor with ID 'nonexistent' not found in catalog
          type: string
        title:
          description: Short error category title.
          example: Not Found
          type: string
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authenticating requests to the Flowker API. Provisioned via
        the API_KEY environment variable during deployment.

````