---
title: "List projects"
method: GET
path: "/v1/projects"
tags: ["Projects"]
---

# List projects

`GET /v1/projects`

## Request

- Base URL: `https://api.workwing.io`
- URL: `https://api.workwing.io/v1/projects`
- Auth: HTTP bearer

List projects with their window, progress counts and crew. Use `GET /v1/jobs?project_id={id}` for a project's jobs. Scope: `read:jobs`.

## Query parameters

- `customer_id` string, uuid
- `status` string
- `limit` integer
- `offset` integer

## Response `200`

Default Response

- object
  - `data` object[], required
    - `id` string, uuid
    - `job_number` string, nullable: Human-readable project identifier (PRJ0001 by default)
    - `title` string, nullable: Optional name for the project, shown instead of its number
    - `kind` 'T_PROJECT'
    - `status` string
    - `priority` string, nullable
    - `customer_id` string, uuid
    - `customer_name` string, nullable
    - `brand_id` string, uuid
    - `location_id` string, uuid, nullable
    - `template_id` string, uuid, nullable
    - `scheduled_start` string, date-time, nullable
    - `scheduled_end` string, date-time, nullable
    - `notes` string, nullable
    - `child_count` integer: Jobs currently attached to this project
    - `child_completed_count` integer: Attached jobs in a completed state
    - `created_at` string, date-time, nullable
    - `updated_at` string, date-time, nullable
    - `crew` object[]: Resources assigned to the project itself. Only crew may claim its jobs.
      - `resource_id` string, uuid
      - `resource_name` string, nullable
      - `assignment_status` string
  - `meta` object, required
    - `request_id` string, required
    - `timestamp` string, date-time, required

---

[API](https://skmtc.dev/workwing/apis/workwing-api.md) · [All operations](https://skmtc.dev/workwing/apis/workwing-api/llms.txt) · [OpenAPI document](https://skmtc.dev/workwing/apis/workwing-api/revisions/54bb14368a35?raw)