Skip to main content
GET
/
v1
/
catalog
/
templates
/
{id}
Get a Catalog Template
curl --request GET \
  --url https://flowker.sandbox.lerian.net/v1/catalog/templates/{id} \
  --header 'X-API-Key: <api-key>'
{
  "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"
}

Authorizations

​
X-API-Key
string
header
required

API key for authenticating requests to the Flowker API. Provisioned via the API_KEY environment variable during deployment.

Path Parameters

​
id
string
required

Unique identifier of the catalog template.

Response

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

​
category
string

Template category.

Example:

"payments"

​
description
string

Description of the template.

Example:

"Validate payment with balance check and risk analysis"

​
id
string

Unique identifier of the template.

Example:

"payment-validation"

​
name
string

Display name of the template.

Example:

"Payment Validation"

​
paramSchema
string

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\"}}}"

​
version
string

Template version.

Example:

"1.0.0"