Manage Categories

Login as an administrative user before using these API calls.

get

Get almost every thing related all categories. These include name, configured icons, users who can access the category, list of all available icons and optionally information about all users in the system.

Parameter Notes
c admin
t category
oper get
users set to yes if you want to include information about all users in the system.
?c=admin&t=category&oper=get&users=true
{
    "status": "ok",
    "error": "",
    "validate": 0,
    "ids": [
        {
            "name": "All Domains",
            "caticon": "folder-gray.png",
            "id": "1"
        },
        {
            "name": "ResellerClub Domains",
            "caticon": "folder-gray.png",
            "id": "12",
            "userids": [
                1
            ]
        },
        {
            "name": "GoDaddy Domains",
            "caticon": "folder-gray.png",
            "id": "11",
            "userids": [
                1
            ]
        },
        {
            "name": "Parked Domains",
            "caticon": "folder-jade.png",
            "id": "3",
            "userids": [
                1,
                6
            ]
        },
        {
            "name": "Keyword Domains",
            "caticon": "folder-gray.png",
            "id": "2",
            "userids": [
                1,
                6
            ]
        },
        {
            "name": "Personal Domains",
            "caticon": "folder-gray.png",
            "id": "4",
            "userids": [
                1,
                3
            ]
        },
        {
            "name": "Business Domains",
            "caticon": "folder-gray.png",
            "id": "5",
            "userids": [
                1,
                3
            ]
        },
        {
            "name": "Bookmarked Domains",
            "caticon": "folder-gray.png",
            "id": "6",
            "userids": [
                1,
                3,
                6
            ]
        },
        {
            "name": "Low Traffic Domains",
            "caticon": "folder-gray.png",
            "id": "8",
            "userids": [
                1,
                3
            ]
        },
        {
            "name": "High Traffic Domains",
            "caticon": "folder-gray.png",
            "id": "7",
            "userids": [
                1,
                6
            ]
        },
        {
            "name": "Desired Domains",
            "caticon": "folder-gray.png",
            "id": "10",
            "userids": [
                1
            ]
        },
        {
            "name": "Important Domains",
            "caticon": "lightning.png",
            "id": "9",
            "userids": [
                1
            ]
        }
    ],
    "icons": [
        "bulb.png",
        "calculator.png",
        "calendar.png",
        "cart.png",
        "check.png",
        "client.png",
        "clock.png",
        "color-black.png",
        "color-blue.png",
        "color-green.png",
        "color-red.png",
        "color-white.png",
        "color-yellow.png",
        "creditcard.png",
        "flag-green.png",
        "flag-red.png",
        "folder-brown.png",
        "folder-cyan.png",
        "folder-gray.png",
        "folder-green.png",
        "folder-jade.png",
        "folder-ruby.png",
        "folder-yellow.png",
        "gear.png",
        "key.png",
        "lightning.png",
        "lock.png",
        "magnifier.png",
        "star.png",
        "target.png",
        "trash.png"
    ],
    "users": [
        {
            "id": "3",
            "name": "elijah",
            "dname": "Elijah Baley",
            "admin": true
        },
        {
            "id": "1",
            "name": "softnik",
            "dname": "Softnik",
            "admin": false
        },
        {
            "id": "6",
            "name": "daneel",
            "dname": "Daneel Olivah",
            "admin": false
        }
    ]
}

set

Parameter Notes
c admin
t category
oper set
cid Category id to set data for.
name Category name to set.
icon Icon file name for the category.
ids List of all category ids in the order they should appear in category list.
uids The ids of all users who can access the category.

Set one or more of category name, sort order, users allowed to access the category and icon file name for a category.

?c=admin&t=category&oper=set&id=9&name=My%20Important%20%20Domains&icon=target.png&ids=12%2C11%2C3%2C2%2C4%2C9%2C5%2C6%2C8%2C7%2C10&uids=1,6
{
    "status": "ok",
    "error": "",
    "validate": 0,
    "icon": "target.png",
    "name": "My Important  Domains",
    "id": 9,
    "changed": 2
}

del

Delete one or more categories

Parameter Notes
c admin
t category
oper del
cids Comma separated list of category ids to delete

remove

Remove domains from category

Parameter Notes
c admin
t category
oper remove
cid Category Id to add domains to
id

Comma separated list of domain ids (sid) to remove from the category.

If this is set to all, all the domains will be removed from the category.

add

Add domains to category

Parameter Notes
c admin
t category
oper add
cid Category Id to add domains to
id comma separated list of domain ids (sid) to add to the category