Workspace API

List Favorite Views

List the current user's ordered Favorite Views with GET /workspace/favorite-views.

GET https://api.parcelengineering.com/api/v1/workspace/favorite-views

Returns the authenticated user’s Favorites in personal order, with each View’s shared definition and metadata.

List Favorites costs 0 credits. Requires a user JWT and workspace membership. API keys receive 400 user_identity_required.

Query parameters

Parameter	Type	Required	Description
`workspace_id`	string (UUID)	Yes (JWT)	Attribution for the user session.
`limit`	integer 1..100	No	Default `25`.
`offset`	integer ≥ 0	No	Default `0`.

curl "https://api.parcelengineering.com/api/v1/workspace/favorite-views?workspace_id=w1e2f3a4-0001-4b7c-9e5d-000000000001" \
  -H "Authorization: Bearer eyJhbGciOi..."

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/favorite-views?workspace_id=w1e2f3a4-0001-4b7c-9e5d-000000000001',
  {
    headers: { 'Authorization': 'Bearer eyJhbGciOi...' },
  }
);

const { data, metadata } = await response.json();

Response

{
  "data": {
    "views": [
      {
        "id": "a1b2c3d4-0001-4e8d-bf6a-000000000001",
        "workspace_id": "w1e2f3a4-0001-4b7c-9e5d-000000000001",
        "dataset": "account",
        "view_type": "dynamic",
        "name": "Tier 1 architects",
        "definition": {
          "version": 1,
          "q": "",
          "fields": { "icp_tier": ["tier_1"] }
        },
        "presentation": {
          "version": 1,
          "sorting": [],
          "column_visibility": {}
        },
        "revision": 1,
        "created_by": "d1e2f3a4-0001-4b7c-9e5d-000000000001",
        "updated_by": "d1e2f3a4-0001-4b7c-9e5d-000000000001",
        "created_at": "2026-07-01T12:00:00.000Z",
        "updated_at": "2026-07-01T12:00:00.000Z",
        "is_favorite": true,
        "favorite_position": 0
      }
    ]
  },
  "metadata": { "limit": 25, "offset": 0, "credits": 0 }
}

Favoriting does not copy the View. Renaming the shared View updates every Favorite automatically.