Workspace API

Get a Project

Fetch one workspace project by UUID with GET /workspace/projects/{id}.

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

Fetches a single project from your workspace by its UUID, including your custom fields and Parcel’s computed project data. Returns 404 if the project does not exist in your workspace (even if it exists in the global dataset).

Query parameters

Parameter	Description
`include`	Comma-separated list of related records to embed. Valid values: `accounts`, `contacts`, `signals`. Repeat the parameter for multiple includes.
`workspace_id`	Attribution. Required when authenticating with a user JWT. Optional for API keys.

Example with includes:

GET /workspace/projects/7b2e4d1f-0001-4c8e-af6b-000000000001?include=accounts&include=signals

curl https://api.parcelengineering.com/api/v1/workspace/projects/7b2e4d1f-0001-4c8e-af6b-000000000001 \
  -H "Authorization: Bearer pcl_your_api_key"

const response = await fetch(
  'https://api.parcelengineering.com/api/v1/workspace/projects/7b2e4d1f-0001-4c8e-af6b-000000000001',
  {
    headers: {
      'Authorization': 'Bearer pcl_your_api_key',
    },
  }
);

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

Response

{
  "data": {
    "id": "7b2e4d1f-0001-4c8e-af6b-000000000001",
    "name": "100 Seaport Boulevard",
    "city": "Boston",
    "state": "MA",
    "stage": "under_construction",
    "primary_use": "mixed_use",
    "residential_units": 120,
    "gross_floor_area_sf": 180000,
    "cost_of_construction_usd": 42000000,
    "last_signal_at": "2026-06-01T00:00:00Z",
    "created_at": "2024-09-10T08:00:00Z",
    "accounts_count": 3,
    "contacts_count": 5,
    "workspace_status": "watching",
    "notes": "GC bid due Q3",
    "tags": ["seaport", "mixed-use"]
  },
  "metadata": { "credits": 1 }
}