Projects

For more details on how to work with custom fields please refer to Working with custom fields guide.

Note: For archived projects, only the name and project_manager_id attributes can be updated. All other attributes will be ignored during update operations.

Attributes

archived_at string
Response

Archived at date

budget_id integer
Parameter `filter`

ID of a budget linked to this project.

company company
Response

The client company linked to this project.

company_id integer
Request Parameter `filter`

ID of the client company associated with this project.

company_name object
Parameter `sort`

Name of the client company associated with this project.

cost integer
Parameter `filter`

Total cost across all open budgets for this project, in the organization's base currency.

created_at string
Response Parameter `filter` Parameter `sort`

Timestamp when this project was created.

custom_field_attachments array of attachment
Response

File attachments referenced by custom field values on this project.

custom_field_people array of person
Response

People referenced by person-type custom field values on this project.

custom_fields object
Response Request Parameter `filter` Parameter `sort`

Custom field values for this project, keyed by custom field ID.

duplication_status string
Response Enum

Background duplication status when copying from a template. One of: idle, in_progress, done, failed.

Enum Values (3 values)

  • idle
    Idle
  • in_progress
    In Progress
  • failed
    Failed
estimated_time integer
Parameter `filter`

Total estimated time across all open budgets for this project, in minutes.

for_tracking boolean
Parameter `filter`

Whether this project is eligible for time tracking (i.e. active).

full_query string
Parameter `filter`

Full-text search query across all project content fields.

fuzzy_dates string
Parameter `filter`

Fuzzy date range filter for project start/end dates.

fuzzy_people integer
Parameter `filter`

Fuzzy person filter — matches projects by associated people.

id integer
Parameter `filter`

Unique project ID.

jump_query string
Parameter `filter`

Quick-jump search query for project navigation.

last_activity_at string
Response Parameter `sort`

Timestamp of the most recent activity on this project.

last_actor person
Response

The person who last performed an activity on this project.

name string
Response Request Parameter `filter` Parameter `sort`

Project name.

number string
Response Parameter `filter` Parameter `sort`

Auto-generated unique project number.

organization organization
Response

The organization this project belongs to.

page_custom_fields_ids object
Response Request

Ordered list of custom field IDs enabled for pages in this project.

page_custom_fields_positions object
Response Request

Display position order for page custom fields in this project.

parent_company_id integer
Parameter `filter`

ID of the parent company of the client linked to this project, used for hierarchical company filtering.

pending_invoicing integer
Parameter `filter`

Total amount pending invoicing across all open budgets for this project, in the organization's base currency.

person_id integer
Parameter `filter`

ID of a person who is a member of this project.

preferences object
Response Request

Project-level display and behavior preferences.

profit integer
Parameter `filter`

Total profit across all open budgets for this project, in the organization's base currency.

profit_margin integer
Parameter `filter`

Profit margin percentage across all open budgets for this project.

project_color integer
Parameter `filter`

Display color label for the project.

project_color_id integer
Response Request

Display color ID for the project.

project_id integer
Parameter `filter`

Alias for the project ID field.

Response

The project manager responsible for this project.

project_manager_id integer
Request

ID of the project manager (responsible person).

project_number string
Response Parameter `filter` Parameter `sort`

Formatted project number string (e.g. ACME-001).

project_type integer
Parameter `filter` Enum

Human-readable project type label.

Enum Values (2 values)

  • 1
  • 2
project_type_id integer
Response Request Enum

Whether this project is billable client work (1) or internal overhead (2).

Enum Values (2 values)

  • 1
    Internal project
  • 2
    Client project
public_access boolean
Parameter `filter`

Deprecated. No-op — has no effect.

query string
Parameter `filter`

Full-text search query across project fields.

responsible_id integer
Parameter `filter`

ID of the responsible person (project manager) for this project.

revenue integer
Parameter `filter`

Total revenue across all open budgets for this project, in the organization's base currency.

sample_data boolean
Response

Whether this project was created with sample/demo data.

status integer
Parameter `filter` Enum

Project status. 1 = active, 2 = archived.

Enum Values (2 values)

  • 1
  • 2
tag_colors string
Response Request

Color mappings for project tags, keyed by tag name.

task_custom_fields_ids object
Response Request

Ordered list of custom field IDs enabled for tasks in this project.

task_custom_fields_positions object
Response Request

Display position order for task custom fields in this project.

template string
Response Parameter `filter`

Whether this project is a template.

template_object template
Response

The template this project was created from, if any.

total_worked_time integer
Parameter `filter`

Total worked time across all budgets (including closed) for this project, in minutes.

with_templates boolean
Parameter `filter`

When true, includes project templates in the results (templates are excluded by default).

worked_time integer
Parameter `filter`

Total worked time across all open budgets for this project, in minutes.

workflow workflow
Response

The task workflow used in this project.

workflow_id integer
Request Parameter `filter`

ID of the task workflow used in this project.