List template version rows
Platform module
GET/template-versionstemplateVersions.list
A version of a template (1032): the project defaults and ordered items. Edited while a draft; publishing (templateVersions.publish) freezes it and makes it the template's current version. Returns a cursor page of template version rows the caller may see. The default order is `template_id`, then `version_number` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability projects.project.read.
- OAuth scopes: projects.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: 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).Constraints: 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. |
Response 200: a page of TemplateVersion
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the template version. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row. |
| template_id | string (uuid) | Yes | Identifier of the template. |
| version_number | integer | Yes | Version number, issued in order, 1 first.Constraints: range 1 to any |
| notes | string | null | Yes | What changed in this version.Constraints: length 1 to 20000 |
| default_time_zone | string | null | Yes | IANA time zone a new project starts with.Constraints: pattern ^[A-Za-z_]+(\/[A-Za-z0-9_+-]+)*$ |
| default_tier_code | string | null | Yes | Canon tier a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_region_code | string | null | Yes | Canon region a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_jurisdiction_id | string | null | Yes | Canon jurisdiction a new project starts with.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| default_currency_code | string | null | Yes | ISO 4217 currency a new project starts with.Constraints: pattern ^[A-Z]{3}$ |
| duration_days | integer | null | Yes | Length of the project in days.Constraints: range 1 to any |
| published_at | string (date-time) | null | Yes | When the version was published; null while a draft. |
{
"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_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"version_number": 1,
"notes": "Adds the load-out records.",
"default_time_zone": "America/New_York",
"default_tier_code": "05",
"default_region_code": "SE",
"default_jurisdiction_id": "US-FL-MIAMI-DADE",
"default_currency_code": "USD",
"duration_days": 3,
"published_at": "2026-10-08T14:30:00Z"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/template-versions" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.templateVersions.listAll()) {
console.log(row);
}for row in xos.template_versions.list_all():
print(row)xos template-versions list --all