List Categories

List all Categories.

application/json

Body

result

required

Any of

allOf {2}

array[object (schemas-categories) {6}]

allOf {2}

One of

array[object (schemas-categories) {6}]

object

beta

boolean

beta

optional

Whether the category is in beta and subject to change.

Example:

false

class

enum<string>

class

optional

Which account types are allowed to create policies based on this categories. blocked categories are blocked unconditionally for all accounts. removalPending categories can be removed from policies but not added. noBlock categories cannot be blocked.

Allowed values:

freepremiumblockedremovalPendingnoBlock

Example:

premium

description

string

categories_components-schemas-description

optional

A short summary of domains in the category.

Example:

Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions.

integer

categories_components-schemas-id

optional

The identifier for this category. There is only one category per id.

name

string

categories_components-schemas-name

optional

The name of the category.

Example:

Education

subcategories

array[object (subcategory) {5}]

optional

All subcategories for this category.

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "beta": false,
            "class": "premium",
            "description": "Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions.",
            "id": 0,
            "name": "Education",
            "subcategories": [
                {
                    "beta": false,
                    "class": "premium",
                    "description": "Sites related to educational content that are not included in other categories like Science, Technology or Educational institutions.",
                    "id": 0,
                    "name": "Education"
                }
            ]
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses