projects

Get project

Get a project by ID.

Returns the project details if found and belongs to the organization.

Pass include=counts to populate related_counts with how many emails, documents, drawings, submittals, and so on are filed under the project. Pass include=members to populate members with the users holding a role on it. Both are omitted by default, so the response stays a single-row read.

get/projects/{project_id}

Request

  • Base URL: https://api.cogram.com/v1
  • URL: https://api.cogram.com/v1/projects/{project_id}
  • Auth: HTTP bearer

Path parameters

project_idstring required

Query parameters

includeProjectIncludeV1[]

Optional response sections. counts populates related_counts; members populates members. Omitted sections come back as null. Repeat the param (include=counts&include=members) or comma-separate the values (include=counts,members) — both work.

Response

Successful Response

idstring required
namestring required
descriptionstring nullable required
external_idstring nullable required

Your system's ID for this project.

client_namestring nullable required
project_addressstring nullable required
is_activeboolean required

False once the project is archived.

email_filing_enabledboolean required
meeting_filing_enabledboolean required

Whether Cogram suggests this project for meetings and, where the organization allows it, files meetings into it. Only takes effect while the organization has meeting filing turned on. Filing a meeting here by hand works either way.

is_publicboolean required

If true, project appears in org project directory; non-members can request access.

unanet_project_idstring nullable required

Unanet ERP A/E project id, for projects synced from Unanet; null for every other project. Stable across customer re-codes, so join on this rather than on external_id.

unanet_lead_stagestring nullable required

Unanet lead/pursuit stage name (e.g. "06-Submitted Proposal"). Set means an open opportunity; null means a normal project.

unanet_custom_fieldsobject nullable required

The project's Unanet user-defined fields, keyed by Unanet fieldName. Replaced in full on each sync, so a cleared field disappears.

created_atstring date-time required
updated_atstring date-time nullable required

Tracks the project record only — not the emails, RFIs, meetings or other records filed under it. Null if never updated.

Changes

No recorded changes to this operation across all 2 revisions of this API.