Get all categories for a specific project
GET/categories/:projectId
Get all categories for a specific project
Request
Path Parameters
projectId projectIdrequired
ID of the project to retrieve categories for
Query Parameters
categoryId categoryId
Optional ID of the category to treat as the root
Responses
- 200
- 403
- 404
- 500
- default
Categories successfully retrieved
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
id categoryId (string)
Unique identifier for Category
name string
Category name
children
object[]
name string
Category name
children
id string
Category Id
{
"id": "C16w81Bvr0",
"name": "Fantasy animals",
"children": [
{
"name": "Dragons",
"children": {},
"id": "CWZTp1wnm"
}
]
}
[
{
"name": "Fantasy animals",
"children": [
{
"children": [
{
"children": [],
"name": "Dragons",
"id": "Cl1RfnQTy"
}
],
"name": "Magical Creatures",
"id": "C17r3cW2m"
},
{
"name": "Beasts of Burden",
"children": [
{
"id": "C16naMbvS",
"name": "Tal'Dorei",
"children": []
}
],
"id": "CkIaWdWRL"
}
],
"id": "C16w81Bvr0"
}
]
Forbidden
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Forbidden access"
}
NotFound
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "A mandatory item was not found"
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "Internal Server Error"
}
Unexpected error
- application/json
- Schema
- Example (from schema)
- Example
Schema
error string
{
"error": "string"
}
{
"error": "An unexpected error occured"
}
Loading...