All Products
Search
Document Center

Qoder CN Series:Get a template

Last Updated:Jul 15, 2026

Retrieve a Forward Template by ID.

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

Returns the full Template object, including Agent configuration and Session default settings.

Request headers

Header

Required

Description

Authorization

Yes

Bearer <PAT>

Path parameters

Parameter

Type

Required

Description

template_id

string

Yes

Forward Template ID.

Sample request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/templates/tmpl_support' \
  -H "Authorization: Bearer $QODER_PAT"

Sample response

HTTP 200 OK

{
  "type": "template",
  "id": "tmpl_support",
  "name": "Support assistant",
  "description": "Handles customer support requests",
  "status": "active",
  "model": "ultimate",
  "system": "You are a helpful support assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [],
  "environment_id": "env_support",
  "vaults": {
    "vault_019f18f2761b": {
      "enabled": true
    }
  },
  "files": {},
  "environment_variables": {
    "BASE_MODE": "support"
  },
  "metadata": {},
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:00:00Z"
}

Response fields

Field

Type

Description

type

string

Always template.

id

string

Template ID.

name

string

Template name.

status

string

Template status.

model

string | object

Model identifier. Can be a model ID string, or an Agent model object containing id and optional tuning fields.

vaults

object

Default Vault configuration, keyed by Vault ID.

metadata

object

Custom metadata.

Errors

HTTP

Type

Code

Trigger condition

404

not_found_error

-

Template does not exist or is not visible to the current caller.

401

authentication_error

authentication_required

PAT is invalid or expired.

403

permission_error

-

Current caller does not have access to this resource.

Notes

  • Archived Templates can still be queried via this endpoint.

  • The response does not expose private runtime fields.

Related