📄Custom field main categories

All dynamic field categories

API

GET https://{API_HOST}/api/v1/cz-col-category

Example

type	Type
0	Customer custom field
1	Customer custom form
2	Ticket custom field
3	Ticket custom form

Response

PROPERTY	TYPE	DESCRIPTION
data	Array of objects	Custom field category array
meta	Object	Pagination data

{
    "data": [
        {
            "id": 1,
            "name": "SF",
            "type": 0,
            "description": null,
            "cols": [
                {
                    "id": 1,
                    "name": "Unique Code",
                    "description": null,
                    "is_allowed_null": true,
                    "default": null,
                    "type": 1,
                    "options": null,
                    "category_id": 1,
                    "creater_id": null
                },
                {
                    "id": 2,
                    "name": "TESTCLICK__C",
                    "description": null,
                    "is_allowed_null": true,
                    "default": null,
                    "type": 2,
                    "options": null,
                    "category_id": 1,
                    "creater_id": null
                }
            ],
            "creater_id": null,
            "creater": null
        },
        {
            "id": 2,
            "name": "Other",
            "type": 0,
            "description": null,
            "cols": [
                {
                    "id": 3,
                    "name": "Do Not Disturb",
                    "description": null,
                    "is_allowed_null": true,
                    "default": null,
                    "type": 2,
                    "options": null,
                    "category_id": 2,
                    "creater_id": null
                },
                {
                    "id": 4,
                    "name": "Last Activity Date",
                    "description": null,
                    "is_allowed_null": true,
                    "default": null,
                    "type": 1,
                    "options": null,
                    "category_id": 2,
                    "creater_id": null
                }
            ],
            "creater_id": null,
            "creater": null
        }
    ],
    "links": {
        "first": "https://firstline.localhost/api/cz-col-category?page=1",
        "last": "https://firstline.localhost/api/cz-col-category?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "https://firstline.localhost/api/cz-col-category",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}

Custom fields owned by this contact/ticket

POST https://{API_DOMAIN}/api/v1/contact/{contact}/cz-col

Filtered according to the Query Parameters form parameters below.

curl -X GET
    -H "Content-Type: application/json:Authorization: Bearer eyJhbGciOiJIUzI1NiI..." https://{API_HOST}/api/v1/contact/1/cz-col

Query Parameters

PARAMETER	REQUIRED	DEFAULT	TYPE	DESCRIPTION
contact	true	NULL	Number	Customer id of

Response

Please refer todynamic fieldsresponse format.

{
    "data": [
        {
            "id": 1,
            "name": "Cyril223",
            "default": null,
            "description": "Assumenda est corrupti voluptas aut. Beatae quisquam ex asperiores sit ullam.",
            "is_allowed_null": true,
            "type": 4,
            "created_at": "2019-04-10 04:09:27",
            "updated_at": "2019-04-10 04:09:27",
            "category_id": null,
            "creater_id": null,
            "pivot": {
                "contact_id": 1,
                "cz_col_id": 1,
                "value": null
            }
        },
        {
            "id": 2,
            "name": "Geovany63",
            "default": null,
            "description": "Dolorum rerum ut est quam unde recusandae consequatur. Nobis laudantium eum et voluptatem sunt sint. Et occaecati voluptas ut aliquid cum sed.",
            "is_allowed_null": true,
            "type": 1,
            "created_at": "2019-04-10 04:09:27",
            "updated_at": "2019-04-10 04:09:27",
            "category_id": null,
            "creater_id": null,
            "pivot": {
                "contact_id": 1,
                "cz_col_id": 2,
                "value": "5"
            }
        }
    ]
}