Saltar al contenido

Get a saved view

Módulo Platform

GET/saved-views/{id}savedViews.get

A saved view of a collection: filters, sort, grouping and view type. Returns one saved view with its `ETag`. A saved view the caller may not see returns 404.

  • Requiere la capacidad my_work.items.read.
  • Alcances de OAuth: my_work.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

savedViews.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the saved view.
fieldsFieldsNoSparse 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: SavedView

savedViews.get: SavedView
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the saved view.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
namestringSíView name.Restricciones: length 1 to 300
view_typestringSíView type from `views.yaml`.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
sharedbooleanSíWhether the view is shared with the org.
membership_idstring (uuid)SíIdentifier of the member who owns the view.
collection_keystringSíCollection the view shows, such as records or objects/sponsors.Restricciones: length 1 to 300
group_by_fieldstring | nullSíField rows are grouped by, if any.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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": "Blocked Permits This Month",
  "view_type": "table",
  "shared": false,
  "membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "collection_key": "records",
  "group_by_field": "record_state"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/saved-views/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.savedViews.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.saved_views.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos saved-views get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f