> For the complete documentation index, see [llms.txt](https://docs.shortcutco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.shortcutco.com/developers/api-reference/reference/objects/project.md).

# The project object

The project object in the Shortcut API - every field, an example, and the endpoints that return it.

## Fields

| Field              | Type           | Description                                                             |
| ------------------ | -------------- | ----------------------------------------------------------------------- |
| `id`               | id             | The project's id.                                                       |
| `object`           | `"project"`    | Always `project`.                                                       |
| `name`             | string         | Its name.                                                               |
| `reference`        | string or null | The workspace's reference for it.                                       |
| `customerPoNumber` | string or null | The customer's purchase order number.                                   |
| `stage`            | string         | Where it stands, e.g. `draft`, `estimating`, `in_progress`, `complete`. |
| `customerId`       | id             | The customer it is for.                                                 |
| `customerName`     | string         | The customer's name.                                                    |
| `onHold`           | boolean        | Whether it is on hold.                                                  |
| `holdResumeDate`   | string or null | When a hold ends, `YYYY-MM-DD`.                                         |
| `createdAt`        | timestamp      | When it was created, ISO 8601 in UTC.                                   |
| `updatedAt`        | timestamp      | When it last changed, ISO 8601 in UTC.                                  |

## Example

```json
{
  "id": "104e467c-0c98-41c3-88e2-bd0a052cf851",
  "object": "project",
  "name": "Weekly mowing",
  "reference": "Check 2204",
  "customerPoNumber": "Example customerPoNumber",
  "stage": "Example stage",
  "customerId": "7364a818-6fae-435f-8bf9-1ea6684359ed",
  "customerName": "Example customerName",
  "onHold": true,
  "holdResumeDate": "2026-10-20",
  "createdAt": "2026-10-16T17:04:12.381Z",
  "updatedAt": "2026-10-16T17:04:12.381Z"
}
```

## Endpoints

| Endpoint                | What it does  |
| ----------------------- | ------------- |
| `GET /v1/projects`      | List projects |
| `GET /v1/projects/{id}` | Get a project |

## Project details

The answer of `GET /v1/projects/{id}/change-orders/{changeOrderId}/details`, `GET /v1/projects/{id}/details`.

| Field                                  | Type                               | Description                                                                                             |
| -------------------------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `id`                                   | id                                 |                                                                                                         |
| `object`                               | `"project"`                        |                                                                                                         |
| `customerId`                           | id                                 |                                                                                                         |
| `quote`                                | object                             |                                                                                                         |
| `quote.id`                             | id                                 |                                                                                                         |
| `quote.kind`                           | `project_estimate`, `change_order` |                                                                                                         |
| `quote.revisionNumber`                 | integer                            |                                                                                                         |
| `quote.status`                         | string                             |                                                                                                         |
| `quote.sentAt`                         | timestamp or null                  |                                                                                                         |
| `quote.expiresAt`                      | timestamp or null                  |                                                                                                         |
| `quote.signedAt`                       | timestamp or null                  |                                                                                                         |
| `quote.createdAt`                      | timestamp                          |                                                                                                         |
| `quote.updatedAt`                      | timestamp                          |                                                                                                         |
| `quote.message`                        | string or null                     |                                                                                                         |
| `quote.includesTimeAndMaterials`       | boolean                            | True when the quote includes T\&M work. The calculated quote total is not a final T\&M bill.            |
| `quote.lines`                          | array of objects                   |                                                                                                         |
| `quote.lines[].id`                     | id                                 |                                                                                                         |
| `quote.lines[].phaseId`                | id or null                         |                                                                                                         |
| `quote.lines[].name`                   | string                             |                                                                                                         |
| `quote.lines[].description`            | string or null                     |                                                                                                         |
| `quote.lines[].kind`                   | string                             |                                                                                                         |
| `quote.lines[].quantity`               | number                             |                                                                                                         |
| `quote.lines[].unit`                   | string or null                     |                                                                                                         |
| `quote.lines[].unitPrice`              | number or null                     |                                                                                                         |
| `quote.lines[].price`                  | number                             |                                                                                                         |
| `quote.lines[].discountAllocated`      | number                             |                                                                                                         |
| `quote.lines[].included`               | boolean                            |                                                                                                         |
| `quote.lines[].selected`               | boolean                            |                                                                                                         |
| `quote.lines[].isOptional`             | boolean                            |                                                                                                         |
| `quote.lines[].isCredit`               | boolean                            |                                                                                                         |
| `quote.lines[].taxable`                | boolean                            |                                                                                                         |
| `quote.phases`                         | array of objects                   |                                                                                                         |
| `quote.phases[].id`                    | id                                 |                                                                                                         |
| `quote.phases[].name`                  | string                             |                                                                                                         |
| `quote.phases[].billingMode`           | `fixed`, `tm`                      |                                                                                                         |
| `quote.phases[].workType`              | string                             |                                                                                                         |
| `quote.phases[].budgetMinutes`         | number                             |                                                                                                         |
| `quote.phases[].tmEstimatedMinutes`    | number or null                     |                                                                                                         |
| `quote.phases[].tmRatePerHour`         | number or null                     |                                                                                                         |
| `quote.phases[].priceTotal`            | number                             |                                                                                                         |
| `quote.phases[].discountAllocated`     | number                             |                                                                                                         |
| `quote.phases[].priceAfterDiscount`    | number                             |                                                                                                         |
| `quote.phases[].taxablePriceTotal`     | number                             |                                                                                                         |
| `quote.totals`                         | object                             |                                                                                                         |
| `quote.totals.subtotal`                | number                             |                                                                                                         |
| `quote.totals.discountAmount`          | number                             |                                                                                                         |
| `quote.totals.preTaxTotal`             | number                             |                                                                                                         |
| `quote.totals.tax`                     | number                             |                                                                                                         |
| `quote.totals.quotedTotal`             | number                             |                                                                                                         |
| `changeOrder`                          | object or null                     |                                                                                                         |
| `changeOrder.id`                       | id                                 |                                                                                                         |
| `changeOrder.number`                   | integer or null                    |                                                                                                         |
| `changeOrder.status`                   | string                             |                                                                                                         |
| `changeOrder.reason`                   | string                             |                                                                                                         |
| `changeOrder.billingMode`              | `fixed`, `tm`                      |                                                                                                         |
| `changeOrder.scheduleImpactDays`       | integer                            |                                                                                                         |
| `changeOrder.startedBeforeSigned`      | boolean                            |                                                                                                         |
| `changeOrder.approvedAt`               | timestamp or null                  |                                                                                                         |
| `changeOrder.declinedReason`           | string or null                     |                                                                                                         |
| `work`                                 | array of objects or null           | Complete native scheduling phases and displayed days, or null when scheduling detail was not requested. |
| `work[].id`                            | id                                 |                                                                                                         |
| `work[].proposalPhaseId`               | id or null                         |                                                                                                         |
| `work[].changeOrderId`                 | id or null                         |                                                                                                         |
| `work[].name`                          | string                             |                                                                                                         |
| `work[].source`                        | string                             |                                                                                                         |
| `work[].status`                        | string                             |                                                                                                         |
| `work[].pending`                       | boolean                            |                                                                                                         |
| `work[].budgetMinutes`                 | number                             |                                                                                                         |
| `work[].scheduleMinutes`               | number                             |                                                                                                         |
| `work[].firstDay`                      | date or null                       |                                                                                                         |
| `work[].lastDay`                       | date or null                       |                                                                                                         |
| `work[].hold`                          | object or null                     |                                                                                                         |
| `work[].hold.at`                       | timestamp                          |                                                                                                         |
| `work[].hold.note`                     | string or null                     |                                                                                                         |
| `work[].hold.reason`                   | string or null                     |                                                                                                         |
| `work[].hold.resumeDate`               | date or null                       |                                                                                                         |
| `work[].teams`                         | array of objects                   |                                                                                                         |
| `work[].teams[].teamId`                | id                                 |                                                                                                         |
| `work[].teams[].teamName`              | string                             |                                                                                                         |
| `work[].teams[].days`                  | array of objects                   |                                                                                                         |
| `work[].teams[].days[].id`             | id                                 |                                                                                                         |
| `work[].teams[].days[].date`           | date                               |                                                                                                         |
| `work[].teams[].days[].status`         | string                             |                                                                                                         |
| `work[].teams[].days[].plannedMinutes` | number                             |                                                                                                         |

```json
{
  "id": "104e467c-0c98-41c3-88e2-bd0a052cf851",
  "object": "project",
  "customerId": "7364a818-6fae-435f-8bf9-1ea6684359ed",
  "quote": {
    "id": "9777940e-93c1-4f55-800c-0a9c8c5645e3",
    "kind": "project_estimate",
    "revisionNumber": 1,
    "status": "Example status",
    "sentAt": "2026-10-16T17:04:12.381Z",
    "expiresAt": null,
    "signedAt": null,
    "createdAt": "2026-10-16T17:04:12.381Z",
    "updatedAt": "2026-10-16T17:04:12.381Z",
    "message": "Thanks for the chance to quote your lawn care.",
    "includesTimeAndMaterials": true,
    "lines": [
      {
        "id": "bb3935d7-b783-411e-83cd-ac65b017e7ac",
        "phaseId": "9ecdfd22-9b18-4869-8762-73b093acaef7",
        "name": "Weekly mowing",
        "description": null,
        "kind": "Example kind",
        "quantity": 1,
        "unit": "Example unit",
        "unitPrice": 42,
        "price": 45,
        "discountAllocated": 45,
        "included": true,
        "selected": true,
        "isOptional": false,
        "isCredit": false,
        "taxable": true
      }
    ],
    "phases": [
      {
        "id": "948dabca-90d7-4711-8d22-2258896c5d9f",
        "name": "Weekly mowing",
        "billingMode": "fixed",
        "workType": "Example workType",
        "budgetMinutes": 45,
        "tmEstimatedMinutes": 45,
        "tmRatePerHour": 45,
        "priceTotal": 45,
        "discountAllocated": 45,
        "priceAfterDiscount": 45,
        "taxablePriceTotal": 45
      }
    ],
    "totals": {
      "subtotal": 120,
      "discountAmount": 45,
      "preTaxTotal": 45,
      "tax": 45,
      "quotedTotal": 45
    }
  },
  "changeOrder": {
    "id": "7e5441b6-7a9e-4cfd-86e8-b8447332f38b",
    "number": 1042,
    "status": "Example status",
    "reason": "Customer asked to pause for the winter.",
    "billingMode": "fixed",
    "scheduleImpactDays": 1,
    "startedBeforeSigned": true,
    "approvedAt": null,
    "declinedReason": "Example declinedReason"
  },
  "work": [
    {
      "id": "f20489d9-ee4e-4520-8a99-0067e6e33bae",
      "proposalPhaseId": "c59f300e-c1e9-4b55-8e33-a69cba7de1e3",
      "changeOrderId": "62b9fdb5-5f04-48fc-8b4e-74435798af8a",
      "name": "Weekly mowing",
      "source": "mywebsite",
      "status": "Example status",
      "pending": true,
      "budgetMinutes": 45,
      "scheduleMinutes": 45,
      "firstDay": "2026-10-20",
      "lastDay": "2026-10-20",
      "hold": {
        "at": "2026-10-16T17:04:12.381Z",
        "note": "Example note",
        "reason": "Customer asked to pause for the winter.",
        "resumeDate": "2026-10-20"
      },
      "teams": [
        {
          "teamId": "cb7ffe86-c7ca-49cd-8414-7514c05eb05b",
          "teamName": "Example teamName",
          "days": [
            {
              "id": "e5fe6494-e248-4fdb-8e92-db22dadd1669",
              "date": "2026-10-20",
              "status": "Example status",
              "plannedMinutes": 45
            }
          ]
        }
      ]
    }
  ]
}
```
