Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
ProjectManagement > Project

Reads a single Project

What does it do? This reads the data of projects, and retrieves the information based on the permissions:
  • If the user has the team_leader permission, he will only be able to read the projects that he is the team leader.
  • If the user has the reportees permission, he will only be able to read the projects that he is the team leader or the projects that he is a team member.
  • If the user has everyone permission, he will be able to read all projects.
  • If the user has the owned permission, he will only be able to read the projects that he is the assigned.
Is it related to other entities? A project is always related to a company, so you can use the query params to list only the projects that are related to a specific company. ###### Who can use it? Only companies who have enabled the projects_management feature and users with the permission of read projects.
get/api/2026-07-01/resources/project_management/projects/{id}

Path parameters

idstring required

Retrieve only the projects that matches the ids provided in the request.

Response

OK

idstring required

The id of the project

namestring required

The name of the project

codestring

The code of the project

descriptionstring

The description of the project

start_datestring

The start date of the project

due_datestring

The end date of the project

status'active' | 'closed' | 'draft' | 'processing' required

The lifecycle status of the project (whether it is still running and can take new charges)

employees_assignment'manual' | 'company' required

How employees get access to the project — manual (hand-picked members) or company (everyone in the company)

inputed_minutesinteger

The total minutes tracked in the project (if requested)

is_billableboolean required

Whether the project's costs can be billed (recharged) to a client

fixed_cost_centsinteger

Total fixed costs in cents

labor_cost_centsinteger

Total labor costs in cents

legal_entity_idstring required

The legal entity id of the project

spending_cost_centsinteger

Total spending costs in cents

client_idstring

The client of the project, refers to finance/contacts.

total_cost_centsinteger

Total Cost in cents

Example response

{
  "id": "314159",
  "name": "Project name",
  "code": "PRO",
  "description": "A comprehensive project to develop and implement a new customer relationship management system",
  "start_date": "2025-01-01",
  "due_date": "2026-01-01",
  "status": "active",
  "employees_assignment": "manual",
  "inputed_minutes": 123,
  "is_billable": true,
  "fixed_cost_cents": 123,
  "labor_cost_cents": 123,
  "legal_entity_id": "123",
  "spending_cost_cents": 123,
  "client_id": "123",
  "total_cost_cents": 123
}