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

name string

Search for categories by name

page integer

Possible values: >= 1

Default value: 1

Specify the page number for pagination (default is 1).

limit integer

Default value: 10

Specify number of results per page at top-level in tree (default is 10, 0 gets all results).

Responses

200

Categories successfully retrieved

application/json

Schema

Schema

id categoryId (string)

Unique identifier for Category

children

object[]

Array [

name string

Category name

children

id string

Category Id

]

name string

Category name

Example (from schema)

{
  "id": "C16w81Bvr0",
  "children": [
    {
      "name": "Dragons",
      "children": {},
      "id": "CWZTp1wnm"
    }
  ],
  "name": "Fantasy animals"
}

Example

[
  {
    "children": [
      {
        "id": "C17r3cW2m",
        "children": [
          {
            "id": "Cl1RfnQTy",
            "children": [],
            "name": "Dragons"
          }
        ],
        "name": "Magical Creatures"
      },
      {
        "children": [
          {
            "name": "Tal'Dorei",
            "children": [],
            "id": "C16naMbvS"
          }
        ],
        "id": "CkIaWdWRL",
        "name": "Beasts of Burden"
      }
    ],
    "id": "C16w81Bvr0",
    "name": "Fantasy animals"
  }
]

403

Forbidden

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Forbidden access"
}

404

NotFound

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "A mandatory item was not found"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "Internal Server Error"
}

default

Unexpected error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Example

{
  "error": "An unexpected error occured"
}

Loading...