v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
ProjectManagement > Subproject

Reads a single Subproject

What does it do?

This reads all subprojects created

What params does it accept?
  • ids: retrieve only the subprojects that matches the ids passed in the request.\n
  • include_inputed_minutes: if true we will perform the minutes calculations and will be return the total inputed_minutes. If the param is not passed in the request, its default value is FALSE so it will return inputed_minutes: 0 and no minutes calculations will be performed.
  • updated_after: this parameter is needed to filter subprojects created or updated after a date.
Is it related to other entities?

A subproject is always related to a project, so you can use the query params to list only the subprojects that are related to a specific project.

Who can use it?

Only companies who have enabled the projects_with_subprojects feature and users with the permission of read subprojects.

get/api/2026-07-01/resources/project_management/subprojects/{id}

Path parameters

idstring required

Retrieve only the subprojects that matches the ids passed in the request.

Response

OK

idstring

The id of the subproject

namestring required

The name of the subproject

project_idstring required

The id of the project

inputed_minutesinteger

The total minutes tracked in the subproject (if requested)

labor_cost_centsinteger

The total labor cost of the subproject in cents (if requested)

descriptionstring

The description of the subproject

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

The status of the subproject

codestring

The code of the subproject

start_datestring

The start date of the subproject

due_datestring

The due date of the subproject

is_billableboolean

Whether the subproject is billable

Example response

{
  "id": "314",
  "name": "Subproject name",
  "project_id": "11",
  "labor_cost_cents": 540000,
  "description": "Subproject description",
  "status": "active",
  "code": "SUB123",
  "start_date": "2025-01-01",
  "due_date": "2025-12-31",
  "is_billable": true
}