Developer Docs

Table of contents

Get contact fields

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

Request parameters

ParameterTypeDescription 
idintegerCustom field ID for contacts. Generated by the BSG system automatically when a field is created.
typestringContact field type. Possible values:
– string ― field with the “Text” type;
– integer ― field with the “Number”  type;
– datetime ― field with the “Date and time” type.
namestringName of the custom contact field.
descriptionstringDescription of the custom contact field.
is_visibleboolWhether 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
    }
  ]
}

We use cookies (and other similar technologies) to collect data to improve your experience on our site. By using our website, you’re agreeing to the collection of data as described in our Website Data Collection Policy.