> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.coperniq.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.coperniq.io/_mcp/server.

# Get Project

GET https://api.coperniq.io/v1/projects/{project_id}

Retrieve a specific project by ID.

**Note:** If the project has no `title` (empty or whitespace-only), the response returns the parent account's `title` instead. The stored value is not modified — this is a read-time fallback only.


Reference: https://docs.coperniq.io/api-reference/projects/get-project

## Authentication

- `x-api-key` header (required) — API Key authentication via header

## Request

### Path parameters

- `project_id` (integer, required) — Project identifier

### Query parameters

- `include_virtual_properties` (boolean, optional, default: false) — Whether to include virtual properties in the response. Defaults to false unless explicitly set to true.
- `include_archived` (boolean, optional, default: false) — Whether to include archived (inactive) records in the response. By default only active records are returned.
- `include_contacts` (boolean, optional, default: false) — Whether to include associated contacts in the response. Defaults to false unless explicitly set to true.

## Response

### 200

Project details

- `trades` (list of enum, optional) — Array of trade types
  - Allowed values: `EV Charger`, `Solar`, `Storage`, `Boiler`, `Chiller`, `Ductwork`, `HVAC`, `Refrigeration`, `Electrical`, `Generator`, `Lighting`, `Gas Line`, `Plumbing`, `Water Filtration`, `Water Heater`, `Communications`, `Electronic Safety & Security`, `Integrated Automation`, `Insulation`, `Gutters`, `Roofing`, `Siding`, `Windows`, `Drywall`, `General Contracting`, `Home Improvement`, `Landscaping`, `R&R (Remove & Reinstall)`, `Tenant Improvement`, `Tree Cutting`
- `value` (double, optional, nullable) — Project value
- `size` (double, optional, nullable) — Project size
- `workflowId` (integer, optional, nullable) — Associated workflow ID
- `accountId` (integer, optional, nullable) — Associated account ID
- `ownerId` (integer, optional, nullable) — ID of the owning user
- `salesRepId` (integer, optional, nullable) — ID of the assigned sales rep
- `projectManagerId` (integer, optional, nullable) — ID of the assigned project manager
- `projectManager` (ProjectWithPhaseInstancesProjectManager, optional, nullable) — Assigned project manager, `null` when unset. Same shape as `owner` and `salesRep`.
- `status` (enum, optional) — Status of the project: * `ACTIVE` - Project is active and in progress * `ON_HOLD` - Project is temporarily paused * `CANCELLED` - Project has been cancelled * `COMPLETED` - Project has been completed
  - Allowed values: `ACTIVE`, `ON_HOLD`, `CANCELLED`, `COMPLETED`
- `stage` (ProjectWithPhaseInstancesStage, optional) — Current stage information (Workflows 1.0). This object is present only for records still using the original Stage-based workflow engine. When the project is managed by Workflows 2.0 (Phase engine) the `stage` object and related fields (`stageId`, `timeInStageDays`, `slaStatus`) are omitted.
- `phase` (ProjectWithPhaseInstancesPhase, optional) — Current phase information (Workflows 2.0). This object replaces `stage` when a project is attached to the Phase-based workflow engine. If the project is still on Workflows 1.0 this object will be omitted. Only populated on GET (list, search, get by id) — omitted on create/update responses.
- `phaseTimeline` (list of ProjectWithPhaseInstancesPhaseTimelineItems, optional) — Only present on `GET /projects` and `/projects/search` when `entered_phase_id`/`exited_phase_id` is used to filter the results. Contains the project's full phase-transition history (not just the matched phase) in compact form — use `GET /projects/{project_id}` for the complete `phaseInstances` with names, positions, and SLA info.
- `lineItemsUpdatedAt` (string, optional, nullable) — Only present on `GET /projects` and `/projects/search` when `include_line_item_updates=true` is passed together with `updated_after` and/or `updated_before`. The most recent `updatedAt` among the project's own scope line items (estimate/scope items; line items on quotes/invoices are excluded). `null` if the project has no scope line items. Useful for telling whether a row matched the date window via its own `updatedAt` or via a line item edit.
- `workflowName` (string, optional) — Name of the associated workflow.
- `contacts` (list of ContactRef, optional) — Contacts associated with this project (independent of, and not inherited from, the parent account's contacts). Set on create or update via the `contacts` request field. On GET requests, only populated when include_contacts=true is passed. Always populated on POST (create) and PATCH (update) responses. Ordered with the primary contact first, capped at 20 contacts.
- `phaseInstances` (list of ProjectWithPhaseInstancesPhaseInstancesItems, optional) — Ordered list of phase instances for the project. Returned by `GET /projects/{project_id}`, and on lists and search with `include_phases=true`.

## Errors

### 401 Unauthorized Error

Authentication failed

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`

### 404 Not Found Error

Resource not found

- `message` (string, optional)
- `code` (enum, optional)
  - Allowed values: `NOT_FOUND`

## Types

### ProjectWithPhaseInstancesProjectManager

Assigned project manager, `null` when unset. Same shape as `owner` and `salesRep`.

- `id` (integer, optional)
- `firstName` (string, optional)
- `lastName` (string, optional)

### ProjectWithPhaseInstancesStage

Current stage information (Workflows 1.0). This object is present only for records still using the original Stage-based workflow engine. When the project is managed by Workflows 2.0 (Phase engine) the `stage` object and related fields (`stageId`, `timeInStageDays`, `slaStatus`) are omitted.

- `id` (integer, optional) — Stage identifier
- `name` (string, optional) — Stage name
- `type` (string, optional) — Stage type
- `scope` (string, optional) — Stage scope
- `redSla` (integer, optional) — Red SLA threshold in days
- `yellowSla` (integer, optional) — Yellow SLA threshold in days
- `timeInStageDays` (integer, optional) — Number of days in current stage
- `slaStatus` (enum, optional) — Current SLA violation status
  - Allowed values: `VIOLATED`, `NON_VIOLATED`

### ProjectWithPhaseInstancesPhase

Current phase information (Workflows 2.0). This object replaces `stage` when a project is attached to the Phase-based workflow engine. If the project is still on Workflows 1.0 this object will be omitted. Only populated on GET (list, search, get by id) — omitted on create/update responses.

- `instanceId` (integer, optional) — Phase instance identifier
- `templateId` (integer, optional) — Phase template identifier
- `name` (string, optional) — Phase name
- `status` (string, optional) — Current phase status
- `type` (string, optional) — Phase type
- `redSla` (integer, optional) — Red SLA threshold in days (from template)
- `yellowSla` (integer, optional) — Yellow SLA threshold in days (from template)
- `timeInStageDays` (integer, optional) — Number of days in current phase (mirrors `timeInStageDays` metric)
- `slaStatus` (enum, optional) — Current SLA violation status for the phase
  - Allowed values: `VIOLATED`, `NON_VIOLATED`
- `startedAt` (string, optional, nullable) — When the current phase started. Present on `GET /projects/{project_id}` and on lists with `include_phases=true`.
- `completedAt` (string, optional, nullable) — When the current phase completed. Present on `GET /projects/{project_id}` and on lists with `include_phases=true`.

### ProjectWithPhaseInstancesPhaseTimelineItems

- `phaseTemplateId` (integer, optional)
- `startedAt` (string, optional, nullable) — Timestamp when the project entered this phase template
- `completedAt` (string, optional, nullable) — Timestamp when the project exited this phase template

### ContactRef

- `id` (integer, optional)
- `name` (string, optional)
- `title` (string, optional, nullable) — Contact title (e.g. job title)
- `description` (string, optional, nullable)
- `emails` (list of string, optional)
- `phones` (list of string, optional)
- `isPrimary` (boolean, optional) — True for the primary contact (the first contact in the list). At most one contact is primary.

### ProjectWithPhaseInstancesPhaseInstancesItems

- `id` (integer, optional)
- `name` (string, optional)
- `status` (enum, optional)
  - Allowed values: `NOT_STARTED`, `IN_PROGRESS`, `COMPLETED`
- `position` (integer, optional)
- `type` (string, optional)
- `phaseTemplateId` (integer, optional)
- `phaseTemplate` (PhaseTemplateSummary, optional)
- `startedAt` (string, optional, nullable) — Timestamp when the phase instance started
- `completedAt` (string, optional, nullable) — Timestamp when the phase instance completed

### PhaseTemplateSummary

- `id` (integer, optional)
- `name` (string, optional)
- `type` (string, optional)
- `redSla` (integer, optional, nullable)
- `yellowSla` (integer, optional, nullable)

## Examples

**Response**

```json
{
  "trades": [
    "EV Charger"
  ],
  "value": 1.1,
  "size": 1.1,
  "workflowId": 1,
  "accountId": 1,
  "ownerId": 1,
  "salesRepId": 1,
  "projectManagerId": 1,
  "projectManager": {
    "id": 1,
    "firstName": "string",
    "lastName": "string"
  },
  "status": "ACTIVE",
  "stage": {
    "id": 1,
    "name": "string",
    "type": "string",
    "scope": "string",
    "redSla": 1,
    "yellowSla": 1,
    "timeInStageDays": 1,
    "slaStatus": "VIOLATED"
  },
  "phase": {
    "instanceId": 1,
    "templateId": 1,
    "name": "string",
    "status": "string",
    "type": "string",
    "redSla": 1,
    "yellowSla": 1,
    "timeInStageDays": 1,
    "slaStatus": "VIOLATED",
    "startedAt": "2024-01-15T09:30:00Z",
    "completedAt": "2024-01-15T09:30:00Z"
  },
  "phaseTimeline": [
    {
      "phaseTemplateId": 1,
      "startedAt": "2024-01-15T09:30:00Z",
      "completedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "lineItemsUpdatedAt": "2024-01-15T09:30:00Z",
  "workflowName": "string",
  "contacts": [
    {
      "id": 1,
      "name": "string",
      "title": "string",
      "description": "string",
      "emails": [
        "string"
      ],
      "phones": [
        "string"
      ],
      "isPrimary": true
    }
  ],
  "phaseInstances": [
    {
      "id": 1,
      "name": "string",
      "status": "NOT_STARTED",
      "position": 1,
      "type": "string",
      "phaseTemplateId": 1,
      "phaseTemplate": {
        "id": 1,
        "name": "string",
        "type": "string",
        "redSla": 1,
        "yellowSla": 1
      },
      "startedAt": "2024-01-15T09:30:00Z",
      "completedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "id": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "title": "string",
  "description": "string",
  "address": [
    "string"
  ],
  "isActive": true,
  "primaryEmail": "string",
  "primaryPhone": "string",
  "number": 1,
  "createdBy": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "avatarUrl": "string"
  },
  "updatedBy": {
    "id": 1,
    "firstName": "string",
    "lastName": "string",
    "email": "string",
    "avatarUrl": "string"
  },
  "custom": {}
}
```

**SDK Code**

```python
import requests

url = "https://api.coperniq.io/v1/projects/1"

headers = {"x-api-key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.coperniq.io/v1/projects/1';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.coperniq.io/v1/projects/1"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.coperniq.io/v1/projects/1")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.coperniq.io/v1/projects/1")
  .header("x-api-key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.coperniq.io/v1/projects/1', [
  'headers' => [
    'x-api-key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.coperniq.io/v1/projects/1");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.coperniq.io/v1/projects/1")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```