List and search clients
List all groups:
GET /api/v2/custom_fields.json
Example of response:
{
{
"tenant_id": null,
"is_global": true,
"name": "Call Summary",
"description": null,
"type": "string",
"enable": true,
"ai_assist": false,
"display_as": "multiline",
"str_max_len": 1024,
"editable": true,
"search_options": [
"advanced"
],
"field_id": "063e593e-5188-11ee-a855-0015172d2a7d"
},
{
"tenant_id": null,
"is_global": true,
"name": "Call type",
"description": null,
"type": "option",
"enable": true,
"ai_assist": true,
"display_as": "default",
"editable": true,
"search_options": [
"advanced"
],
"options": [
"Collection call",
"Sales call"
],
"field_id": "9079d60a-5192-11ee-aa89-0015172d2a7d"
},
{
"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"
},
"total": 3,
"next_url": null
}
See also Paging through collections
Search custom fields:
-
Search by custom field name and tenant name (in multi-tenant version)
GET /api/v2/custom_fields.json?search_term=Contoso
-
Search by tenant id
GET /api/v2/custom_fields.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff
-
Search by multiple parameters (
tenant_id
andsearch_term
)GET /api/v2/custom_fields.json?tenant_id=2bfcefd4-f41d-11e4-983d-e03f497dbdff&search_term=Contoso