Reads all Project workers

get https://api.factorialhr.com/api/2024-10-01/resources/project_management/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.

Query Params

ids[]

array of integers

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

ids[]

project_ids[]

array of integers

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

project_ids[]

subproject_ids[]

array of integers

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

subproject_ids[]

no_subproject

boolean

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

employee_ids[]

array of integers

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

employee_ids[]

assigned

boolean

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

project_active

boolean

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

employee_name

string

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

include_inputed_minutes

boolean

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_cost

boolean

updated_after

string

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

include_labor_cost

boolean

Response

Language

Credentials

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.factorialhr.com/api/2024-10-01/resources/project_management/project_workers \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK