v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Catalog API

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.

get/v1/catalog/templates/{id}

Path parameters

idstring required

Unique identifier of the catalog template.

Response

Indicates that the request was successful and the response contains the requested data.

categorystring

Template category.

descriptionstring

Description of the template.

idstring

Unique identifier of the template.

namestring

Display name of the template.

paramSchemastring

JSON Schema defining the expected parameters for this template. Dynamically enriched with active provider configuration options when applicable.

versionstring

Template version.

Example response

{
  "category": "payments",
  "description": "Validate payment with balance check and risk analysis",
  "id": "payment-validation",
  "name": "Payment Validation",
  "paramSchema": "{\"type\":\"object\",\"properties\":{\"midaz_config_id\":{\"type\":\"string\"}}}",
  "version": "1.0.0"
}