List all projects

GET v1/projects?page=<int>&pageLimit=<int>&mode=<'days' | 'hours'>&sort=<'name' | 'createdAt' | 'totalAllocation'>&direction=<'ASC' | 'DESC'>

Allow to retrieve all projects in the owned workspace.

Query parameters

Name	Type	Description	Required	Default
page	int	Selected page number	No	1
pageLimit	int	Number of items returned per call	No	15
sort	string	Field of the project to be sorted	No	'createdAt'
direction	string	Indicates the sorting direction	No	'ASC'
mode	string	Indicates whether the totalAllocation will be reported in days or hours	No	'days'

Request Body Parameters

 No body parameters

Response

{
    "status": 200,
    "value": {
        "message": "string",
        "status": 200,
        "count": "int",
        "totalCount": "int",
        "currentPage": "int",
        "nextPage": "int" | null,
        "prevPage": "int" | null,
        "data": [
            {
                "id": "string",
                "name": "string",
                "status": <ProjectStatus>,
                "color": <ProjectColors>,
                "totalAllocation": "number",
                "external_id": "string",
            }
        ]
    }

}

Name	Type	Description	Required	Default
message	string	Message of the response	Yes	-
status	number	Status of the response	Yes	200
count	number	Number of items returned	Yes	0
totalCount	number	Total number of items	Yes	0
currentPage	number	Current page number	Yes	1
nextPage	number	Next page number - null indicates that a new page is not available	No	null
prevPage	number	Previous page number - null indicates that a previous page is not available	No	null
data	object	List of projects	Yes	[]

Data

Name	Type	Description	Required	Default
id	string (uuid)	Project internal identifier	Yes	-
name	string	Project name	Yes	-
color	ProjectColors	Project color	No	gray
status	ProjectStatus	Project status	No	TO_DO
totalAllocation	number	Total allocation	No	0
external_id	string	External reference to the project	No	-