List Categories

List Categories

Endpoint for retrieving all categories.

Request
URI
GET
https://{api_host}/vco/api/categories
COPY
Query Parameters
string
categoryType
Optional

categoryType

boolean
isRoot
Optional
Constraints: default: false

isRoot

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns CategoriesList of type(s) application/json 
{
    "startIndex": 0,
    "count": 0,
    "total": 0,
    "link": [
        {
            "rel": "string",
            "type": "string",
            "attributes": [
                {
                    "name": "string",
                    "displayName": "string",
                    "value": "string",
                    "displayValue": "string"
                }
            ],
            "href": "string"
        }
    ]
}
integer As int32 As int32
startIndex
Optional

startIndex

integer As int32 As int32
count
Optional

count

integer As int32 As int32
total
Optional

total

array of object
link
Optional

link


401

User is not authorized

Returns CategoriesList of type(s) application/json 
"CategoriesList Object"
integer As int32 As int32
startIndex
Optional

startIndex

integer As int32 As int32
count
Optional

count

integer As int32 As int32
total
Optional

total

array of object
link
Optional

link


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/categories
On This Page
Category Service Operations
GET
Get Category
PUT
Update Category
POST
Add Child Category
DELETE
Delete Category
GET
List Categories
POST
Add Root Category