Workspace API

Get a View

Fetch one shared workspace View by UUID with GET /workspace/views/{id}.

GET https://api.parcelengineering.com/api/v1/workspace/views/{id}

Returns one shared View definition and metadata. Unknown or out-of-workspace ids return 404 view_not_found.

Get a View costs 0 credits. Requires workspace:read.

Path parameters

Parameter	Description
`id`	UUID of the View.

Query parameters

Parameter	Type	Required	Description
`workspace_id`	string (UUID)	Conditional	Attribution. Required for user JWT; optional for API keys.

curl https://api.parcelengineering.com/api/v1/workspace/views/a1b2c3d4-0001-4e8d-bf6a-000000000001 \
  -H "Authorization: Bearer pcl_your_api_key"

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/views/a1b2c3d4-0001-4e8d-bf6a-000000000001',
  {
    headers: { 'Authorization': 'Bearer pcl_your_api_key' },
  }
);

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

Response

{
  "data": {
    "view": {
      "id": "a1b2c3d4-0001-4e8d-bf6a-000000000001",
      "workspace_id": "w1e2f3a4-0001-4b7c-9e5d-000000000001",
      "dataset": "account",
      "view_type": "static",
      "name": "Architects to follow",
      "definition": { "version": 1 },
      "presentation": {
        "version": 1,
        "sorting": [],
        "column_visibility": {}
      },
      "revision": 2,
      "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-02T09:00:00.000Z",
      "record_count": 8
    }
  },
  "metadata": { "credits": 0 }
}

See Workspace Views for definition and presentation contracts.