---
title: "Get Project Week"
method: GET
path: "/api/projects/{project_id}/week"
---

# Get Project Week

`GET /api/projects/{project_id}/week`

## Request

- Base URL: `https://app.tin.computer` (the document declares no server; this is the origin it was published from)
- URL: `https://app.tin.computer/api/projects/{project_id}/week`
- Auth: HTTP bearer

A week of the System calendar in the viewer's time zone: runs, then what is to come.

## Path parameters

- `project_id` string, uuid, required

## Query parameters

- `start` string, date, required: The first of seven local days, usually a Monday.
- `timezone` string

## Response `200`

Successful Response

- ProjectWeekView
  - `start` string, date, required
  - `timezone` string, required
  - `runs` WeekRunView[], required
    - `id` string, uuid, required
    - `project_workflow_id` string, uuid, nullable, required
    - `workflow_key` string, required
    - `workflow_title` string, required
    - `status` 'pending' | 'running' | 'needs_input' | 'paused' | 'stopped' | 'succeeded' | 'failed' | 'superseded', required
    - `trigger_source` string, required
    - `at` string, date-time, required
    - `finished_at` string, date-time, nullable, required
    - `title` string, nullable, required
    - `summary` string, nullable, required
    - `progress_current` integer, nullable, required
    - `progress_total` integer, nullable, required
  - `occurrences` WeekOccurrenceView[], required
    - `project_workflow_id` string, uuid, required
    - `name` string, required
    - `workflow_key` string, required
    - `at` string, date-time, required
    - `state` 'planned' | 'paused' | 'held' | 'skipped', required
    - `lands` string, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/tin/apis/tin-lite-switchboard.md) · [All operations](https://skmtc.dev/tin/apis/tin-lite-switchboard/llms.txt) · [OpenAPI document](https://skmtc.dev/tin/apis/tin-lite-switchboard/revisions/c800ca3406f4?raw)