get https://api.talkdeskapp.com/cm/meta/va/fields
Scope
case-fields-public:read
Body Response - Schema
200 OK
| Parameter | Type | Description | Required |
|---|---|---|---|
| id | string | field ID, the unique numeric identifiers given to each case field | yes |
| key | string | the unique key given to each case field | yes |
| name | string | the name given to each case field | yes |
| type | string | type field | yes |
| description | string | a description of the case field that agents can see | no |
| dict_list | array[object] | For some fields, you may have a dictionary entry (such as a drop-down value, etc.) that is the list of the corresponding dictionary entry. "dict_list" subdivides into: 1 - "key" (string) - dict key, the unique identifier of the dict. 2 - "value" (string) - dict value. 3 - "children" (array) - since dict is a nested array structure, children are an array of dictionary children, which also have properties of key, value, and children. | no |
| required | boolean | If true, agents must enter a value in the field to change the case status to solved | yes |
| active | boolean | all fields are active by default and will be inactive if it is deactivated | yes |
| created_at | date | time when the field was created | yes |
| updated_at | date | time when the field was updated | yes |
Response Parameters Sample
[
{
"id": "1",
"key": "drop_down1",
"name": "drop_name"
"type": "001"
"description": "dropdown field desc",
"dict_list": [
{
"key": "001",
"lable": "red"
}
{
"key": "002",
"lable": "blue"
}
]
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "2",
"key": "dependent_field1",
"name": "dependent_field_name",
"type": "002",
"dict_list": [
{
"key": "1001",
"lable": "china",
"children":[
{
"key": "100101",
"lable": "hubei",
"children":[
{
"key": "10010101",
"lable": "wuhan",
"children": null
}
]
}
]
},
{
"key": "1002",
"lable": "U.S.A",
"children": null
}
]
"description": "drop field desc",
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "3",
"key": "multi_select1",
"name": "multi_select_name"
"type": "003"
"description": "multi select field desc",
"dict_list": [
{
"key": "001",
"lable": "red"
}
{
"key": "002",
"lable": "blue"
}
]
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "4",
"key": "text1",
"name": "text1_name"
"type": "004"
"description": "text field desc",
"dict_list": null
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "5",
"key": "multi_line_text1",
"name": "multi_line_text_name"
"type": "005"
"description": "multi text field desc",
"dict_list": null
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "6",
"key": "numeric1",
"name": "numeric_field_name"
"type": "006"
"description": "numeric field desc",
"dict_list": null
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "7",
"key": "decimal1",
"name": "decimal_field_name"
"type": "007"
"description": "decimal field desc",
"dict_list": null
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "8",
"key": "checkbox1",
"name": "checkbox_field_name"
"type": "008"
"description": "check field desc",
"dict_list": null
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
[
{
"id": "9",
"key": "date1",
"name": "date_field_name"
"type": "009"
"description": "date field desc",
"dict_list": null
"required": false,
"active": true,
"created_at": "2022-04-19T07:37:29Z",
"updated_at": "2022-04-19T07:37:29Z"
}
]
API Availability
The Case API has been in GA since October 2023.
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.