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

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://apigw.klinkcx.com/api/v1/contacts/fields' \
--header 'Authorization: Bearer <token>'

Response Example

{
  "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
        }
      ]
    }
  ]
}

Modified at 2026-01-08 17:45:29

Filter By SocialPlatformId

Detail