GET/projects/api/v3/projectcategories.json
Returns a list of project categories
Query Params
- Name
searchTerm
- Type
- string
- Description
filter by name
- Name
onlyStarredProjects
- Type
- boolean
- Description
filter by starred projects only. note: if an owner company admin, counts will honour this filter, but all categories will be returned regardless.
- Name
projectStatuses
- Type
- array[string]
- Description
filter by project statuses. note: if an owner company admin, counts will honour this filter, but all categories will be returned regardless.
- Format
- Comma separated values
- Name
ids
- Type
- array[integer]
- Description
filter by specific ids
- Format
- Comma separated values
- Name
fields[projectcategories]
- Type
- array[string]
- Description
- Format
- Comma separated values
- Allowed values
id
name
color
count
parent
parentId
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 OK
CategoriesResponse contains information about a group of categories.
- Code
- 400
- Type
- object
- Schema
- Description
- 400 Bad Request
ErrorResponse defines how []Error should be marshaled to JSON.
- Code
- 403
- Type
- object
- Schema
- Description
- 403 Forbidden
ErrorResponse defines how []Error should be marshaled to JSON.
200 OK
CategoriesResponse
{
"projectCategories": [
{
"color": "string",
"count": 0,
"id": 0,
"name": "string",
"parent": {
"id": 0,
"meta": {},
"type": "string"
},
"parentId": 0
}
],
"projectCategoryTotals": {
"categorizedItems": 0,
"uncategorizedItems": 0
}
}