Web API Docs Category response

Navigate

Parameters

Parameter Type Description
id Integer Unique identifier of the category.
name String Name of the category.
description String Detailed description of the nature of the category.
created_at Timestamp Date and time, when the category was created.
fields Array A list of fields assigned to this category.
colour String Default colour, which should be used to display features for this category.
symbol String Image URL of a symbol, , which should be used to display features for this category.
order Integer The order in the list of categories.

Example

{
    "id": 39,
    "name": "Restaurants",
    "description": "Local places to eat",
    "status": "active",
    "fields": [
        {
            "id": 113,
            "name": "Name",
            "key": "name",
            "fieldtype": "TextField",
            "description": "The name of the restaurent",
            "status": "active",
            "required": true,
            "maxlength": 20,
            "textarea": false,
            "order": 0
        },
        {
            "id": 114,
            "name": "Address",
            "key": "address",
            "fieldtype": "TextField",
            "description": "",
            "status": "active",
            "required": true,
            "order": 1,
            "maxlength": null,
            "textarea": true,
        },
        {
            "id": 116,
            "name": "Cuisine",
            "key": "cuisine",
            "fieldtype": "LookupField",
            "description": "",
            "required": true,
            "order": 2
            "lookupvalues": [
                {
                    "id": 31,
                    "name": "Italian"
                },
                {
                    "id": 32,
                    "name": "Russian"
                },
                {
                    "id": 33,
                    "name": "British"
                },
                {
                    "id": 34,
                    "name": "German"
                }
            ]
        },
        {
            "id": 115,
            "name": "Number of seats",
            "key": "number_of_seats",
            "fieldtype": "NumericField",
            "description": "",
            "status": "active",
            "required": false,
            "minval": null,
            "maxval": null,
            "order": 3
        }
    ],
    "colour": "#0033ff",
    "symbol": "/assets/symbols/pub.png",
    "created_at": "2014-09-17T00:00:00Z",
    "order": 0
}