ProjectManagement > Project

Reads all Projects

Changed on
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.
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.
get/api/2026-10-01/resources/project_management/projects

Request

  • Base URL
    https://api.factorialhr.com
  • URL
    https://api.factorialhr.com/api/2026-10-01/resources/project_management/projects
  • Auth
    • OAuth 2
      Authorization code: https://id.factorialhr.com/oauth/authorize
      Token URL: https://id.factorialhr.com/api/oauth/token scopes: project_management_projects
    • or API key in header x-api-key

Query parameters

ids[]string[]

Retrieve only the projects that matches the ids provided in the request.

[
  "314159",
  "271828"
]
namestring

Retrieve only the projects that match the name passed in the request. (deprecated)

Example:Project Name
name_or_codestring

Retrieve only the projects that match the name or code passed in the request.

Example:Project Name
include_inputed_minutesboolean required

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
include_costsboolean

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

Example:true
updated_afterstring

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

Example:1993-08-23
legal_entity_idstring

Retrieve only the projects that are related to the legal entity passed in the request.

Example:123
client_ids[]string[]

Retrieve only the projects that are related to the clients passed in the request, refers to finance/contacts.

[
  "314159",
  "271828"
]
no_clientsboolean

Retrieve only the projects that are not related to any client, refers to finance/contacts.

total_currencystring

Retrieve only the projects that have the total cost in the currency passed in the request.

Example:USD

Response

OK

Example response

{
  "data": [
    {
      "id": "314159",
      "name": "Project name",
      "code": "PRO",
      "description": "A comprehensive project to develop and implement a new customer relationship management system",
      "start_date": "2025-01-01",
      "due_date": "2026-01-01",
      "status": "active",
      "employees_assignment": "manual",
      "inputed_minutes": 123,
      "is_billable": true,
      "fixed_cost_cents": 123,
      "labor_cost_cents": 123,
      "legal_entity_id": "123",
      "spending_cost_cents": 123,
      "client_id": "123",
      "total_cost_cents": 123
    }
  ]
}

Changes