---
title: "GET /instance/{InstanceId}/task/template/{TaskTemplateId}"
method: GET
path: "/instance/{InstanceId}/task/template/{TaskTemplateId}"
---

# GET /instance/{InstanceId}/task/template/{TaskTemplateId}

`GET /instance/{InstanceId}/task/template/{TaskTemplateId}`

Gets details about a specific task template in the specified Amazon Connect instance.

## Path parameters

- `InstanceId` string, required
- `TaskTemplateId` string, required

## Query parameters

- `snapshotVersion` string

## Response `200`

Success

- GetTaskTemplateResponse
  - `InstanceId` string — The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.
  - `Id` string, required — A unique identifier for the task template.
  - `Arn` string, required — The Amazon Resource Name (ARN).
  - `Name` string, required — The name of the task template.
  - `Description` string — The description of the task template.
  - `ContactFlowId` string — The identifier of the flow that runs by default when a task is created by referencing this template.
  - `Constraints` object — Constraints that are applicable to the fields listed.
    - `RequiredFields` RequiredFieldInfo[] — Lists the fields that are required to be filled by agents.
      - `Id` object — The unique identifier for the field.
        - `Name` string — The name of the task template field.
    - `ReadOnlyFields` ReadOnlyFieldInfo[] — Lists the fields that are read-only to agents, and cannot be edited.
      - `Id` object — Identifier of the read-only field.
        - `Name` string — The name of the task template field.
    - `InvisibleFields` InvisibleFieldInfo[] — Lists the fields that are invisible to agents.
      - `Id` object — Identifier of the invisible field.
        - `Name` string — The name of the task template field.
  - `Defaults` object — The default values for fields when a task is created by referencing this template.
    - `DefaultFieldValues` TaskTemplateDefaultFieldValue[] — Default value for the field.
      - `Id` object — Identifier of a field.
        - `Name` string — The name of the task template field.
      - `DefaultValue` string — Default value for the field.
  - `Fields` TaskTemplateField[] — Fields that are part of the template.
    - `Id` object, required — The unique identifier for the field.
      - `Name` string — The name of the task template field.
    - `Description` string — The description of the field.
    - `Type` 'NAME' | 'DESCRIPTION' | 'SCHEDULED_TIME' | 'QUICK_CONNECT' | 'URL' | 'NUMBER' | 'TEXT' | 'TEXT_AREA' | 'DATE_TIME' | 'BOOLEAN' | 'SINGLE_SELECT' | 'EMAIL' — Indicates the type of field.
    - `SingleSelectOptions` TaskTemplateSingleSelectOption[] — A list of options for a single select field.
  - `Status` 'ACTIVE' | 'INACTIVE' — Marks a template as <code>ACTIVE</code> or <code>INACTIVE</code> for a task to refer to it. Tasks can only be created from <code>ACTIVE</code> templates. If a template is marked as <code>INACTIVE</code>, then a task that refers to this template cannot be created.
  - `LastModifiedTime` string, date-time — The timestamp when the task template was last modified.
  - `CreatedTime` string, date-time — The timestamp when the task template was created.
  - `Tags` object — The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

## Other responses

- `480` — InvalidRequestException
- `481` — InvalidParameterException
- `482` — ResourceNotFoundException
- `483` — ThrottlingException
- `484` — InternalServiceException

---

[API](https://skmtc.net/aws/apis/connect.md) · [All operations](https://skmtc.net/aws/apis/connect/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/connect/versions/fbcf0a4faed2/schema)