Skip to main content

Get Custom Ticket Field by ID

GET /custom_fields/:field_id/​

URL Example​

https://system_domain/api/v2/custom_fields/123/

PATH Parameters​

ParameterTypeRequiredDescription
field_idnumberYesID of the custom field

Response Example:​

Response Example
{
    "data": {
        "id": 190,
        "name": {
            "en": "new",
            "ru": "",
            "ua": ""
        },
        "field_type": "text",
        // The `permissions` block is deprecated and used only for backward compatibility.
        // It does not affect the current permission logic.
        "permissions": {
            "staff": {
                "view": true,
                "edit": true,
                "required_to_create_ticket": false,
                "required_to_close_ticket": false
            },
            "user": {
                "view": true,
                "edit": false,
                "required_to_create_ticket": false,
                "required_to_close_ticket": false
            }
        },
        // Current permission settings
        "view": [
            26,
            2
        ],
        "edit": [
            2
        ],
        "create_required": [
            33
        ],
        "status_required": {
            "open": [
                28
            ],
            "closed": [
                35
            ]
        }
    }
}