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

# List projects

`GET /projects`

## Request

- Base URL: `https://app.buildworkpro.com/api/v1`
- URL: `https://app.buildworkpro.com/api/v1/projects`
- Auth: HTTP bearer

Returns a cursor-paginated list of projects for the authenticated tenant.

## Query parameters

- `limit` integer
- `cursor` string
- `status` string
- `contactId` integer, nullable
- `search` string
- `dateFrom` string, date-time
- `dateTo` string, date-time
- `updatedFrom` string, date-time
- `compact` boolean: Return compact row projection (id + key fields only).

## Response `200`

Projects page

- object
  - `data` Project[], required
    - `id` integer, required
    - `name` string, required
    - `projectNumber` string, required
    - `contactId` integer, nullable, required
    - `bidId` integer, nullable, required
    - `projectType` string, nullable, required
    - `status` string, required
    - `priority` string, nullable, required
    - `startDate` union, required
      - string, date-time
      - string
    - `expectedEndDate` union, required
      - string, date-time
      - string
    - `actualEndDate` union, required
      - string, date-time
      - string
    - `contractValue` string, nullable, required
    - `originalContractValue` string, nullable, required
    - `description` string, nullable, required
    - `siteAddress` string, nullable, required
    - `siteCity` string, nullable
    - `siteState` string, nullable
    - `siteZipCode` string, nullable
    - `architectName` string, nullable
    - `architectProjectNumber` string, nullable
    - `contractFor` string, nullable
    - `assignedTo` integer, nullable, required
    - `createdAt` union, required
      - string, date-time
      - string
    - `updatedAt` union, required
      - string, date-time
      - string
    - `isPractice` boolean: Read-only. Present on GET /projects/{id}. True for the onboarding practice project a user starts from the setup wizard — demo content that "Clear sample data" removes; false for every other project.
  - `meta` ResponseMeta, required
    - `request_id` string: Server-generated request identifier
    - `pagination` PaginationMeta
      - `cursor` string, nullable, required: Opaque cursor for the next page; null when no more results
      - `has_more` boolean, required: Whether more pages are available after this one
      - `count` integer, required: Items in this page

## Other responses

- `403`: Scope insufficient

---

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