List template item rows

Módulo Platform

GET/template-itemstemplateItems.list

An item of a template version (1032): a scope node created under the new project's engagement root ({KEY}-{suffix}), or a record due a number of days after the project start. Items of a published version are frozen (template_version_published: 422). Returns a cursor page of template item rows the caller may see. The default order is `template_version_id`, then `sort_order` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad projects.project.read.
Alcances de OAuth: projects.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

templateItems.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
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_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de TemplateItem

templateItems.list: TemplateItem
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the template item.
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.
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.
template_version_id	string (uuid)	Sí	Identifier of the template version.
item_kind	"Scope Node" \| "Record"	Sí	What the item creates.
sort_order	integer	Sí	Position in the version, 1 first.Restricciones: range 1 to any
name	string	Sí	Scope node name, or record title.Restricciones: length 1 to 200
scope_kind	"Standing Venue" \| "Show" \| null	Sí	For a scope node: Show or Standing Venue.
scope_code_suffix	string \| null	Sí	For a scope node: code after the project key.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
record_kind	string \| null	Sí	For a record: canon record kind.Restricciones: length 1 to 50
xyz	"X" \| "Y" \| "Z" \| null	Sí	For a record: declared schema family tag.
phase_code	string \| null	Sí	For a record: canon phase.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
due_offset_days	integer \| null	Sí	For a record: due this many days after the project start; null for none.Restricciones: range -3660 to 3660

{
  "data": [
    {
      "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",
      "template_version_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "item_kind": "Scope Node",
      "sort_order": 1,
      "name": "Opening Night",
      "scope_kind": "Show",
      "scope_code_suffix": "E02",
      "record_kind": "Inspection",
      "xyz": "X",
      "phase_code": "SCP",
      "due_offset_days": 3
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/template-items" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.templateItems.listAll()) {
  console.log(row);
}

for row in xos.template_items.list_all():
    print(row)

xos template-items list --all