Reads all Projects

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.
What params does it accept?
  • ids: retrieve only the projects that matches the ids passed in the request.
  • name: DEPRECATED use instead name_or_code.
  • name_or_code: retrieve only the projects that match the name or coded passed in the request.
  • 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 we no minutes calculations will be performed.
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.

Language
Authorization
URL
Click Try It! to start a request and see the response here!