Developer Docs
Using this method, you will get a list of custom contact fields.
To get a contact fields list, make a request to this URL:
GET http://one-api.bsg.world/api/contacts/fields |
Parameter | Type | Description |
id | integer | Custom field ID for contacts. Generated by the BSG system automatically when a field is created. |
type | string | Contact field type. Possible values: – string ― field with the “Text” type; – integer ― field with the “Number” type; – datetime ― field with the “Date and time” type. |
name | string | Name of the custom contact field. |
description | string | Description of the custom contact field. |
is_visible | bool | Whether the field is displayed: true or false value. |
If request is successful, you will receive a response:
{
"data": [
{
"type": "datetime",
"id": 26130,
"name": "Country",
"description": "The country name",
"is_visible": true
},
{
"type": "dropdownlist",
"dropdownlist": [
"string"
],
"id": 26130,
"name": "Country",
"description": "The country name",
"is_visible": true
}
]
}