Retrieve a Forward template by ID.
GET /api/v1/forward/templates/{template_id}
Returns the complete template object, including agent configuration and session defaults.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Forward Template ID. |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
type | string | Always template. |
id | string | Template ID. |
name | string | Template name. |
status | string | active or archived. |
model | string | object | Model ID string, or an object containing id and optional effort, speed, and context_window. See Model. |
max_tool_rounds | integer | Maximum tool-call rounds per Turn. |
multiagent | object | null | Multi-agent configuration. May include {"type":"advisor","model":"ultimate"}; the Advisor model is a string. See Multiagent. |
managed_tool_config | object | Forward managed-capability baseline for the Template. When configured, it is returned as an enabled_tools array. |
vaults | object | Default Vault configuration keyed by Vault ID. |
github_repositories | object | Default GitHub repository configuration. Includes normalized url and final mount_path, but omits authorization_token. |
system | string | System prompt. |
environment_id | string | Default Environment ID. |
metadata | object | Custom metadata. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 403 | permission_error | - | Not authorized for this resource. |
| 404 | not_found_error | - | Template does not exist or is not visible to the caller. |
| 401 | authentication_error | authentication_required | The PAT or SAT is invalid or expired. |
Notes
- Archived templates can still be retrieved by ID.
managed_tool_config.enabled_toolsis the complete Template baseline. Query Identity Config for Identity-level per-selector overrides.scheduleenables the three Forward managed capabilities for creating, listing, and deleting Schedules together.driverepresents the full Drive capability. Responses preserve these configuration selectors without expanding them into execution tool names.- Runtime-only Qoder Cloud Agents fields are not added to this response.
github_repositories.*.authorization_tokenis write-only and is omitted from Template responses.

