Blog
Github
  1. Contact
  • Getting Started
    • Introduction
    • Quickstart
    • Authentication
    • Status codes
  • Webhook
    • Webhook Setup
    • Webhook Events and Schema
  • API Reference
    • Contact
      • Listing
        GET
      • Create
        POST
      • Filter By SocialPlatformId
        GET
      • Form Fields
        GET
      • Detail
        GET
      • Update
        PATCH
      • Delete
        DELETE
      • Fetch Contact Groups
        GET
      • Update tags
        PATCH
    • Tag
      • Listing
    • Channel
      • Listing
      • Create
    • Ticket
      • Listing
      • Create
      • Filter by Contact ID
      • Form Fields
      • Update
      • Update status
    • Category
      • Listing
    • CxLog
      • Listing
    • Message
      • Send message
Blog
Github
  1. Contact

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
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params

Responses

🟢200
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apigw.klinkcx.com/api/v1/contacts/social-platform?socialPlatformId&channelType' \
--header 'Authorization: Bearer <token>'
Response Response Example
{

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

}
Modified at 2026-01-08 17:43:49
Previous
Create
Next
Form Fields
Built with