Skip to main content
GET
Get template details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

code
string
required

Template code, as returned by GET /v1/templates (e.g. steelConnectionHssBeamToHssMomentAISC360-22).

Response

Template details

id
string<uuid>

Identifier of the currently published template version; changes when the template is republished — use code as the stable identifier

version
integer | null

The template version that will serve calculations and sheet creates; null when the template records no version

code
string

Template code

name
string

Human-readable template name

category
string | null

Template category

description
string | null

Brief description of the template; null when the template provides none

fields
object[]

Input field definitions for the template

outputs
object[]

The maximum set a calculate call can return, one entry per output, keyed by referenceId in the results object. Any one calculation carries a subset: outputs can be conditional on inputs, and some kinds (for example gis and customdiagram) are described here but not returned. An output that is also settable appears in fields[] and outputs[], and in both inputs and results, holding the stored value in one and the solved value in the other.

presets
object[]

Available presets for the template