Projects
List projects
Retrieve a list of projects for a client. Results can be filtered by name and ordered by various fields.
get/cloud/v1/projects
Query parameters
include_deletedboolean
Whether to include deleted projects in the response.
Whether to include deleted projects in the response.
limitinteger
Limit value is used to limit the number of records in the result
Example:100
Limit value is used to limit the number of records in the result
namestring
Name to filter the results by.
Example:my-project
Name to filter the results by.
offsetinteger
Offset value is used to exclude the first set of records from the result
Offset value is used to exclude the first set of records from the result
order_by'created_at.asc' | 'created_at.desc' | 'name.asc' | 'name.desc'
Order by field and direction.
Response
OK
Example response
{
"count": 1,
"results": [
{
"client_id": 1,
"created_at": "2019-12-31T23:59:59Z",
"description": "Project description",
"id": 1,
"is_default": true,
"name": "default",
"state": "ACTIVE",
"task_id": "7244e161-664c-4afd-a34e-7003eac4d949"
}
]
}