View a custom field

Request to view a custom field:

GET /api/v2/custom_fields/<field-id>.json

Note

This API endpoint is used to administer custom fields configuration. To assign values to custom fields on call resource, use the PUT /api/v2/calls.json API endpoint.

Example of response:

{
    "custom_field": {
      "tenant_id": null,
      "is_global": true,
      "name": "Product ordered",
      "description": null,
      "type": "string",
      "enable": true,
      "ai_assist": true,
      "display_as": "default",
      "str_max_len": 64,
      "editable": true,
      "search_options": [
        "advanced"
      ],
      "field_id": "2d020436-5189-11ee-a647-0015172d2a7d"
    }
}