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

# Get template details

> Returns detailed information about a specific template, including its input fields and available presets.



## OpenAPI

````yaml api/openapi.json GET /v1/templates/{code}
openapi: 3.1.0
info:
  title: Connections Hub API
  version: 1.0.0
  description: >-
    Run HSS Connections Hub calculators programmatically: create projects,
    create and solve sheets from any calculator template, run batches, and
    export reports to PDF.


    All endpoints require API key authentication.
servers:
  - url: https://api.calcs.com
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: >-
      Create and manage calculation projects. Each user can have multiple
      projects to organize their calculations.
  - name: Sheets
    description: >-
      Manage individual calculation sheets — read one back, update its inputs,
      solve or re-solve it, and delete single sheets or clean up many at once.
  - name: Templates
    description: >-
      Run calculations using any enabled template. Supports all calculator types
      without requiring endpoint-specific code.
paths:
  /v1/templates/{code}:
    get:
      tags:
        - Templates
      summary: Get template details
      description: >-
        Returns detailed information about a specific template, including its
        input fields and available presets.
      operationId: template-detail
      parameters:
        - name: Authorization
          in: header
          required: true
          example: Bearer YOUR_KEY_HERE
          schema:
            type: string
          description: >-
            The `Authorization` header is used to authenticate with the API
            using your API key. Value is of the format `Bearer YOUR_KEY_HERE`.
        - name: code
          in: path
          required: true
          schema:
            type: string
          description: >-
            Template code, as returned by `GET /v1/templates` (e.g.
            `steelConnectionHssBeamToHssMomentAISC360-22`).
      responses:
        '200':
          description: Template details
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: >-
                      Identifier of the currently published template version;
                      changes when the template is republished — use `code` as
                      the stable identifier
                  version:
                    type:
                      - integer
                      - 'null'
                    description: >-
                      The template version that will serve calculations and
                      sheet creates; null when the template records no version
                  code:
                    type: string
                    description: Template code
                  name:
                    type: string
                    description: Human-readable template name
                  category:
                    type:
                      - string
                      - 'null'
                    description: Template category
                  description:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Brief description of the template; null when the template
                      provides none
                  fields:
                    type: array
                    description: Input field definitions for the template
                    items:
                      type: object
                      required:
                        - referenceId
                        - label
                        - type
                        - units
                      properties:
                        referenceId:
                          type: string
                          description: >-
                            Field identifier — the key for this field in the
                            calculate request's attributes object
                        label:
                          type:
                            - string
                            - 'null'
                          description: Human-readable field label
                        type:
                          type: string
                          description: >-
                            Field type: number (numeric input), enum (one of
                            options), or table (tabular input)
                        units:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Units of the field value; null when the template
                            does not declare them. Send a `number` field's value
                            as a string tagged with exactly this unit, for
                            example `"24 ft"`; a field whose units are null
                            takes a plain number, and so do a few that list
                            units, such as a roof slope listed as `:12`. A tag
                            in any other unit, even one that converts to this
                            one, is rejected with a 422 that names the unit to
                            send or asks for the plain number; on calculate and
                            validate the error carries `type: "invalid_unit"`
                            and `expectedUnit` (null when the field takes a
                            plain number).
                        group:
                          type: object
                          description: Section heading this field appears under
                          properties:
                            referenceId:
                              type: string
                            label:
                              type: string
                        defaultValue:
                          description: >-
                            Default value applied when the field is omitted from
                            a calculate request. For an `enum` field this is the
                            option label, so it is usually a member of `options`
                            — but not always. A formula default is returned
                            as-is; so is a default the field's table no longer
                            carries; and where a field's options are numbers the
                            default is the string of one (`"2"` against options
                            `[1, 2]`), which names that option on a write but
                            does not compare equal to it.
                        options:
                          type: array
                          description: Valid choices for enum fields
                        sharedTableId:
                          type: string
                          description: >-
                            Identifier of the shared lookup table backing an
                            enum field
                        description:
                          type: string
                          description: Guidance the template provides for table fields
                        columns:
                          type: array
                          description: Column definitions for table fields
                          items:
                            type: object
                            required:
                              - referenceId
                              - type
                              - units
                            properties:
                              referenceId:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Column identifier; null when the template does
                                  not declare one
                              type:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Column kind (input, computed, lookup, label,
                                  hidden). Each row you write is an array of
                                  values in columns[] order and is stored as
                                  sent, whatever the column kind. A row that is
                                  not an array is rejected with 422. null when
                                  not declared
                              units:
                                type:
                                  - string
                                  - 'null'
                                description: >-
                                  Units of the column's values; null when the
                                  template does not declare them. Send each
                                  number in this column as a string tagged with
                                  this unit, for example `"100 kip"`; a column
                                  whose units are null takes plain numbers.
                              label:
                                type: string
                                description: Human-readable column label
                              symbol:
                                type: string
                                description: Mathematical symbol shown for the column
                              inputType:
                                type: string
                                enum:
                                  - number
                                  - string
                                description: >-
                                  Cell value type for input columns; when
                                  absent, cells are numeric
                  outputs:
                    type: array
                    description: >-
                      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.
                    items:
                      type: object
                      required:
                        - referenceId
                        - label
                        - type
                        - units
                      properties:
                        referenceId:
                          type: string
                          description: >-
                            Key this output uses in the calculate response's
                            results object, when present
                        label:
                          type:
                            - string
                            - 'null'
                          description: Human-readable output label
                        type:
                          type: string
                          description: >-
                            The kind of output. Common values are computed (a
                            calculated value), table (a tabular result), enum
                            and number; others such as gis and customdiagram
                            also occur. Treat this as an open string rather than
                            a fixed set.
                        units:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Units of the output value; null when the template
                            does not declare them
                  presets:
                    type: array
                    description: Available presets for the template
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          description: Preset code
                        name:
                          type: string
                          description: Human-readable preset name
        '404':
          description: The template does not exist, or is not accessible with this API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                not_found:
                  summary: >-
                    Template does not exist, or is not accessible with this API
                    key
                  value:
                    error:
                      code: NOT_FOUND
                      message: Template not found.
      security:
        - api_key: []
components:
  schemas:
    ErrorResponse:
      type: object
      description: >-
        Standard error envelope for handler errors. `code` is a stable
        machine-readable error code (e.g. NOT_FOUND, UPSTREAM_ERROR); `message`
        is human-readable and may change.
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Machine-readable error code.
            message:
              type: string
              description: Human-readable error message.
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Send your API key as a bearer token: `Authorization: Bearer
        YOUR_API_KEY`. Every endpoint requires one.
    api_key:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.