Get a template
Módulo Platform
GET/templates/{id}templates.get
A project or record template, including the XOS 4.0 Production Template copy. Returns one template with its `ETag`. A template the caller may not see returns 404.
- Requiere la capacidad projects.project.read.
- Alcances de OAuth: projects.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the template. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: Template
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the template. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| name | string | Sí | Template name.Restricciones: length 1 to 300 |
| current_version_id | string (uuid) | null | Sí | Identifier of the current version. |
| description | string | null | Sí | When to use the template.Restricciones: length 1 to 20000 |
| template_kind | "Project" | Sí | What the template creates. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"name": "Three-Day Festival",
"current_version_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"description": "Outdoor weekend shows.",
"template_kind": "Project"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/templates/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.templates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.templates.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos templates get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f