Filter By SocialPlatformId

GET/api/v1/contacts/social-platform

This endpoint allows you to retrieve a contact by providing their klink.cloud base on social media platform 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 ********************

Query Params

socialPlatformIdstringrequired
The social platform Id for a channel.
channelTypestringoptional
Channel type is only acceptable for "whatsapp", "messenger", "telegram", "instagram", "line", "viber", "shopee", "lazada", "webchat", "facebook_feed".

Responses

200

statusstringrequired
messagestringrequired
dataarray[object]required
Child attributes
- idstringoptional
- createdAtstringoptional
- updatedAtstringoptional
- deletedAtnulloptional
- namestringoptional
- addressnulloptional
- channelstringoptional
- notesnulloptional
- contactNumberstringoptional
- contactProfilestringoptional
- socialProfileUrlstringoptional
- companyIdnulloptional

Request

curl -X GET "https://apigw.klinkcx.com/api/v1/contacts/social-platform?socialPlatformId=%7BsocialPlatformId%7D" \
  -H "Authorization: Bearer {token}"

Response

{
  "status": "success",
  "message": "contact",
  "data": [
    {
      "id": "...",
      "createdAt": "2025-02-28T07:35:02.659Z",
      "updatedAt": "2025-02-28T07:35:03.978Z",
      "deletedAt": null,
      "name": "Nway",
      "address": null,
      "channel": "facebook_feed",
      "notes": null,
      "contactNumber": "15879",
      "contactProfile": "...",
      "socialProfileUrl": "...",
      "companyId": null
    }
  ]
}