v1
latestOpenAPI 3.1.02026-07-26549156879.0 KBReads all Subprojects
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.
Query parameters
Retrieve only the subprojects that matches the ids passed in the request.
Retrieve only the subprojects that matches the ids passed in the request.
[ "314" ]
Retrieve only the subprojects that belongs to the project ids passed in the request.
Retrieve only the subprojects that belongs to the project ids passed in the request.
[ "11" ]
Retrieve only the subprojects that matches the name passed in the request.
Retrieve only the subprojects that matches the name passed in the request.
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.
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.
If true we will perform the cost calculations and will be return the total labor_cost_cents. If the param is not passed in the request, its default value is FALSE so it will return labor_cost_cents: 0 and no cost calculations will be performed.
If true we will perform the cost calculations and will be return the total labor_cost_cents. If the param is not passed in the request, its default value is FALSE so it will return labor_cost_cents: 0 and no cost calculations will be performed.
Retrieve only the subprojects that were updated after the date passed in the request.
Retrieve only the subprojects that were updated after the date passed in the request.
Response
OK
Example response
{
"data": [
{
"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
}
]
}