---
title: "Get Template"
method: GET
path: "/api/v1/templates/{template_id}"
tags: ["templates"]
---

# Get Template

`GET /api/v1/templates/{template_id}`

## Path parameters

- `template_id` string, required

## Headers

- `x-api-key` string

## Response `200`

Successful Response

- Template
  - `template_name` string, required
  - `user_id` string, nullable
  - `purpose` string, required
  - `metadata` object, nullable
  - `objectives` string, nullable
  - `auto_end_session` boolean, nullable
  - `name` string, required
  - `avatar` string, nullable
  - `style_id` string, nullable
  - `voice_id` string, nullable
  - `created_by_key_id` string, nullable
  - `response_length` 'concise' | 'moderate' | 'detailed'
  - `results` object, nullable
  - `role` string, nullable
  - `tone` string, nullable
  - `context` object, nullable
  - `knowledge_snippet` string, nullable
  - `template_type` string, nullable
  - `parent_template_id` string, nullable
  - `tags` string[], nullable
  - `context_mapping` object, nullable
  - `results_mapping` object, nullable
  - `auth_settings` AuthSettings
    - `require_wf_org_authentication` boolean
  - `timezone` string, nullable
  - `deleted_at` string, nullable
  - `is_deleted` boolean
  - `welcome_message` string, nullable
  - `topics_to_avoid` string, nullable
  - `webhook` Webhook
    - `url` string, required
    - `method` string, nullable
    - `headers` object, nullable
    - `body` object, nullable
  - `template_id` string, required
  - `organization_id` string, nullable
  - `created_at` string, required
  - `updated_at` string, required
  - `failure_reason` string, nullable
  - `image` string, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/soulmachines/apis/soul-machines-interactions-api.md) · [All operations](https://skmtc.net/soulmachines/apis/soul-machines-interactions-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/soulmachines/soul-machines-interactions-api/revisions/4ac38edbb38a/schema)