---
title: "Get project overview"
method: GET
path: "/overview/{id}"
tags: ["Overview"]
---

# Get project overview

`GET /overview/{id}`

Returns project metadata with lightweight member and task snapshots.

## Path parameters

- `id` string, uuid, required

## Response `200`

Overview retrieved successfully

- object
  - `done` boolean, required — Indicates if the operation was successful
  - `body` object, nullable, required — Response data (type varies by endpoint, null if no data)
    - `id` string, uuid
    - `name` string
    - `color_code` string
    - `notes` string, nullable
    - `client_name` string, nullable
    - `members` object[]
      - `id` string, uuid
      - `name` string
      - `job_title` string, nullable
      - `task_count` integer, nullable
    - `tasks` object[]
      - `id` string, uuid
      - `name` string
      - `done` boolean
  - `title` string, nullable — Optional response title
  - `message` string, nullable — Optional message (error message or success notification)

---

[API](https://skmtc.dev/worklenz/apis/worklenz-api.md) · [All operations](https://skmtc.dev/worklenz/apis/worklenz-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/worklenz/worklenz-api/revisions/e44341b9118c/schema)