Get a saved view
Platform module
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.
- Requires the capability my_work.items.read.
- OAuth scopes: my_work.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the saved view. |
| 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_]*)*$ |
Response 200: SavedView
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the saved view. |
| 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; null when a seed, platform or system process created it. |
| 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; null when a seed, platform or system process updated it. |
| name | string | Yes | View name.Constraints: length 1 to 300 |
| view_type | string | Yes | View type from `views.yaml`.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| shared | boolean | Yes | Whether the view is shared with the org. |
| membership_id | string (uuid) | Yes | Identifier of the member who owns the view. |
| collection_key | string | Yes | Collection the view shows, such as records or objects/sponsors.Constraints: length 1 to 300 |
| group_by_field | string | null | Yes | Field rows are grouped by, if any.Constraints: 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"
}Code samples
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