---
title: "GET /connectors/{connectorName}/templates/{datasetName}"
method: GET
path: "/connectors/{connectorName}/templates/{datasetName}"
tags: ["connectors"]
---

# GET /connectors/{connectorName}/templates/{datasetName}

`GET /connectors/{connectorName}/templates/{datasetName}`

## Request

- Base URL: `https://headless.dataddo.com/customer-api/v1`
- URL: `https://headless.dataddo.com/customer-api/v1/connectors/{connectorName}/templates/{datasetName}`
- Auth: none declared

Get template of connector

## Path parameters

- `connectorName` string, required
- `datasetName` string, required

## Response `200`

Get template of connector

- ConnectorTemplateResource: API representation of a single connector dataset template. Keys follow the snake_case public API convention. The payload predates that convention, so the nested resources additionally expose every multi-word key under its legacy camelCase name via a deprecated getter pinned with SerializedName - none of this resource's own keys are multi-word.
  - `id` string
  - `label` string
  - `description` string
  - `authorizer` TemplateAuthorizerResource: Authorizer service a template is wired to. Shared by the connector and destination templates - the shape is identical, hence no prefix.
    - `service` string
    - `type` string
  - `image` string
  - `steps` TemplateStepResource[]
    - `name` string
    - `description` string, nullable
    - `fields` TemplateFieldResource[]
      - `name` string
      - `label` string
      - `type` string
      - `tooltip` string, nullable
      - `required` boolean, nullable
      - `searchable` boolean, nullable
      - `select_first` boolean, nullable
      - `placeholder` string, nullable
      - `url` string, nullable
      - `label_attribute` string, nullable
      - `value_attribute` string, nullable
      - `default_value` union
        - boolean
        - integer
        - string
        - unknown[]
          - unknown
      - `watchers` string[], nullable
      - `message_on_empty` string, nullable
      - `limit` integer, nullable
      - `language` string, nullable
      - `dialect` string, nullable
      - `data` unknown[], nullable
        - unknown
      - `is_visible` TemplateFieldVisibilityResource: Conditional visibility of a form field: show it only while the field named by `on` holds `has_value`, or the other way round when `negate` is set. Shared by the connector, destination, authorizer and flow templates - the shape is identical, hence no prefix. `has_value` and `negate` are nullable and skipped when null, so a template that only names `on` keeps emitting the single key it used to.
        - `on` string
        - `has_value` union
          - boolean
          - string
          - string[]
        - `negate` boolean, nullable
        - `hasValue` union
          - boolean
          - string
          - string[]
      - `additional_data` object, nullable
      - `list_files` TemplateUrlResource: Shape of the `listFiles` and `validator` form field attributes. Shared by the connector and destination templates - the shape is identical, hence no prefix.
        - `url` string
      - `validator` TemplateUrlResource: Shape of the `listFiles` and `validator` form field attributes. Shared by the connector and destination templates - the shape is identical, hence no prefix.
        - `url` string
      - `regex` TemplateFieldRegexResource: Client-side validation of a form field value. Shared by the connector and destination templates - the shape is identical, hence no prefix.
        - `pattern` string
        - `on_error` string
        - `onError` string
      - `default` TemplateFieldDefaultResource
        - `value_url` string
        - `watchers_default` TemplateFieldWatchersDefaultResource
          - `format` string
        - `valueUrl` string
        - `watchersDefault` object, nullable
          - `format` string
      - `description` string, nullable
      - `disable` boolean, nullable
      - `subtype` unknown[], nullable
        - unknown
      - `selectFirst` boolean, nullable
      - `labelAttribute` string, nullable
      - `valueAttribute` string, nullable
      - `defaultValue` union
        - boolean
        - integer
        - string
        - unknown[]
          - unknown
      - `messageOnEmpty` string, nullable
      - `isVisible` object, nullable: Conditional visibility of a form field: show it only while the field named by `on` holds `has_value`, or the other way round when `negate` is set. Shared by the connector, destination, authorizer and flow templates - the shape is identical, hence no prefix. `has_value` and `negate` are nullable and skipped when null, so a template that only names `on` keeps emitting the single key it used to.
        - `on` string
        - `has_value` union
          - boolean
          - string
          - string[]
        - `negate` boolean, nullable
        - `hasValue` union
          - boolean
          - string
          - string[]
      - `additionalData` object, nullable
      - `listFiles` object, nullable: Shape of the `listFiles` and `validator` form field attributes. Shared by the connector and destination templates - the shape is identical, hence no prefix.
        - `url` string
    - `banner` TemplateStepBannerResource
      - `level` string
      - `icon` string
      - `text` string
      - `title` string, nullable
    - `setup` string, nullable
  - `snapshotting` ConnectorTemplateSnapshottingResource
    - `date_range` boolean
    - `historic_data_load` boolean
    - `date_range_data` string, nullable
    - `disable` boolean, nullable
    - `watchers` string[], nullable
    - `dateRange` boolean
    - `historicDataLoad` boolean
    - `dateRangeData` string, nullable
  - `request` ConnectorTemplateRequestResource
    - `url` string
    - `method` string
    - `headers` object
    - `body` string
    - `ensure_data_types` object
    - `transformation` string
    - `pre_call_transformation` string
    - `emitter` string
    - `ensureDataTypes` object
    - `preCallTransformation` string
  - `attributes` ConnectorTemplateSchemaColumnResource[]: Deprecated alias of `schema`.
    - `key` string
    - `type` 'string' | 'date' | 'integer' | 'float' | 'boolean' | 'json' | 'timestamp_ms' | 'decimal' | 'timestamp_tz'
    - `label` string
    - `description` string
    - `sensitive` boolean
    - `in_dataddo_hash` boolean
    - `nullable` boolean
    - `foreign_key` string
    - `format` string, nullable
    - `inDataddoHash` boolean
    - `foreignKey` string
  - `schema` ConnectorTemplateSchemaColumnResource[]
    - `key` string
    - `type` 'string' | 'date' | 'integer' | 'float' | 'boolean' | 'json' | 'timestamp_ms' | 'decimal' | 'timestamp_tz'
    - `label` string
    - `description` string
    - `sensitive` boolean
    - `in_dataddo_hash` boolean
    - `nullable` boolean
    - `foreign_key` string
    - `format` string, nullable
    - `inDataddoHash` boolean
    - `foreignKey` string

---

[API](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api.md) · [All operations](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api/llms.txt) · [OpenAPI document](https://skmtc.dev/dataddo/apis/dataddo-headless-beta-api/revisions/dcfa2345bd10?raw)
