List canon version rows
Módulo Canon
GET/canon/versionscanonVersions.list
The current canon version and generation. Canon responses are cached by generation. Returns a cursor page of canon version rows the caller may see. The default order is `generation` ascending. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad canon.taxonomy.read.
- Alcances de OAuth: canon.
- 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
| 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 CanonVersion
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| version_code | string | Sí | Canon version.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| generation | integer | Sí | Canon generation, incremented by every canon data migration.Restricciones: range 1 to any |
| bible_generated_at | string | Sí | Generation time stated in the Bible _generated tab: a wall-clock time without a zone.Restricciones: length 1 to 300 |
{
"data": [
{
"version_code": "4.0",
"generation": 1,
"bible_generated_at": "2026-10-01 09:00:00"
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/canon/versions" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.canonVersions.listAll()) {
console.log(row);
}for row in xos.canon_versions.list_all():
print(row)xos canon-versions list --all