Form Fields

GET/api/v1/contacts/fields

This endpoint allows you to get available contact fields including the custom fields you have created.

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Responses

200

totalintegerrequired
pageintegerrequired
pageSizeintegerrequired
lastPageintegerrequired
dataarray[object]required
Child attributes
- idstringoptional
- system_namestringoptional
- display_namestringoptional
- typestringoptional
- is_defaultbooleanoptional
- is_archivedbooleanoptional
- is_requiredbooleanoptional
- is_uniquebooleanoptional
- optionsarray[object]optional
  Child attributes
  valuestringrequired
  labelstringrequired
  is_defaultbooleanrequired

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/contacts/fields" \
  -H "Authorization: Bearer {token}"

Response

{
  "total": 49,
  "page": 1,
  "pageSize": 10,
  "lastPage": 5,
  "data": [
    {
      "id": "464b7eef-22ed-435e-9bef-35b58e435eda",
      "system_name": "channel",
      "display_name": "Channel",
      "type": "select",
      "is_default": true,
      "is_archived": true,
      "is_required": true,
      "is_unique": false,
      "options": [
        {
          "value": "phone",
          "label": "Phone",
          "is_default": true
        },
        {
          "value": "G-Mail",
          "label": "G-Mail",
          "is_default": false
        }
      ]
    }
  ]
}