Detail

GET/api/v1/contacts/{id}

This endpoint allows you to retrieve a contact by providing their klink.cloud id. Refer to the list at the top of this page to see which properties are included with contact objects.

Request

Authorization

Bearer Token

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

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

Path Params

idstringrequired
Example:

Responses

200

statusstringrequired
messagestringrequired
dataobjectrequired
Child attributes
- idstringrequired
- namestringrequired
- addressnullrequired
- channelnullrequired
- notesnullrequired
- socialProfileUrlstringrequired
- tagsarray[object]required
  Child attributes
  idstringoptional
  namestringoptional
- companyobjectrequired
  Child attributes
  idstringrequired
  namestringrequired
  phonenullrequired
  addressnullrequired
  industrynullrequired
- emailarray[object]required
  Child attributes
  emailstringoptional
  isPrimarybooleanoptional
- phonearray[object]required
  Child attributes
  phonestringoptional
  isPrimarybooleanoptional
- customFieldsarray[object]required
  Child attributes
  system_namestringoptional
  display_namestringoptional
  typestringoptional
  valuestringoptional

Request

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

Response

{
  "status": "success",
  "message": "contact",
  "data": {
    "id": "c786bb40-a58e-4d60-afe6-061e2b819811",
    "name": "FrankMcCallister",
    "address": null,
    "channel": null,
    "notes": null,
    "socialProfileUrl": "https://assets.protocol.chat/avatars/frank.jpg",
    "tags": [
      {
        "id": "4d45ba6c-728e-4ca8-91cb-91bac1572622",
        "name": "platinum"
      }
    ],
    "company": {
      "id": "547f2af6-1e6d-420e-aaed-b6448d37fd08",
      "name": "K-Link",
      "phone": null,
      "address": null,
      "industry": null
    },
    "email": [
      {
        "email": "frankmccallister@gmail.com",
        "isPrimary": true
      }
    ],
    "phone": [
      {
        "phone": "1-800-759-3000",
        "isPrimary": true
      }
    ],
    "customFields": [
      {
        "system_name": "demo_test",
        "display_name": "demo test ddddfee erefesf",
        "type": "text",
        "value": "another field"
      }
    ]
  }
}