Create

POST
/api/v1/categories

Request Parameters

Name Type Description Required
name string category name Yes
parentCategoryId string GUID for the parent category when creating child categories.

Example Request

{
  "name": "training videos",
  "parentCategoryId": "051631ae-5744-4b9f-8564-96ed7be2e952"
}

Example Response

{
  "categoryId": "4df3f318-8e49-44dc-b0a8-cb1da931f316",
  "name": "training videos",
  "parentCategory":
  {
    "categoryId": "051631ae-5744-4b9f-8564-96ed7be2e952",
    "name": "Human Resources",
    "parentCategory": null
  }
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Delete

NOTE: As of Rev v7.12, this API is available.

DELETE
/api/v1/categories/{categoryId}

Request Parameters

Name Type Description Required
categoryId path GUID for the category. Yes

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

List All Categories

GET
/api/v1/categories

Request Parameters

Name Type Description Required
none

Example Response

{
  "categories": [
  {
    "categoryId": "47c36208-42e5-48b8-8def-a0779f3de196",
    "name": "Education",
    "fullPath": "Education"
  },
  {
    "categoryId": "2d1ea902-fe96-4031-aef0-5af800d95fe4",
    "name": "Schools",
    "fullPath": "Schools"
  },
  {
    "categoryId": "0b091ac2-398f-4879-a9de-a459c34c1751",
    "name": "Sports",
    "fullPath": "Schools\Sports"
  } ]
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error