Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
ProjectManagement > ProjectWorker

Reads all Project workers

What does it do?

This endpoint reads and retrieves a list of project workers. You can utilize URL parameters to filter the results.

Is it related to other entities?

A project_worker is always related to a project and a employee. Only a project worker is able to add time to a project using the time_record entity.

Who can use it?

Only companies who have enabled the projects_management feature and users with the permission to read project workers.

get/api/2026-07-01/resources/project_management/project_workers

Query parameters

ids[]string[]

Retrieve only the project workers that matches the ids provided in the request.

Retrieve only the project workers that matches the ids provided in the request.

[
  "92732",
  "2"
]
project_ids[]string[]

Retrieve only the project workers that matches the project_ids provided in the request.

Retrieve only the project workers that matches the project_ids provided in the request.

[
  "314159",
  "33"
]
subproject_ids[]string[]

Retrieve only the project workers that matches the subproject_ids provided in the request.

Retrieve only the project workers that matches the subproject_ids provided in the request.

[
  "5",
  "6"
]
no_subprojectboolean

Retrieve the project workers that are not assigned to any subproject (can be combined with subproject_ids).

Retrieve the project workers that are not assigned to any subproject (can be combined with subproject_ids).

employee_ids[]string[]

Retrieve only the project workers that are related to the employee_ids provided in the request.

Retrieve only the project workers that are related to the employee_ids provided in the request.

[
  "21",
  "22"
]
assignedboolean

Retrieve project workers that are assigned if true or in not-assigned status if false.

Example:true

Retrieve project workers that are assigned if true or in not-assigned status if false.

project_activeboolean

Retrieve the project workers that are assigned to active projects if turew or closed projects if false.

Example:true

Retrieve the project workers that are assigned to active projects if turew or closed projects if false.

employee_namestring

Retrieve only the project workers that matches the given employee's name provided in the request.

Example:John D

Retrieve only the project workers that matches the given employee's name provided in the request.

include_inputed_minutesboolean

If true we will perform the minutes calculations and will be return the total inputed_minutes. If false, 0 will be returned and no minutes calculations will be performed.

Example:true

If true we will perform the minutes calculations and will be return the total inputed_minutes. If false, 0 will be returned and no minutes calculations will be performed.

include_costboolean

If true, costs of the project worker will be included to the response.

Example:true

If true, costs of the project worker will be included to the response.

updated_afterstring

Retrieve only the project workers that were created or updated after the date provided in the request.

Example:1993-08-23

Retrieve only the project workers that were created or updated after the date provided in the request.

include_labor_costboolean

Response

OK

Example response

{
  "data": [
    {
      "id": "92732",
      "project_id": "314159",
      "employee_id": "21",
      "assigned": true,
      "inputed_minutes": 100,
      "labor_cost_cents": 100,
      "company_labor_cost_cents": 100,
      "spending_cost_cents": 100
    }
  ]
}