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

Listing

GET
/api/v1/contacts
This endpoint allows you to retrieve a paginated list of all your contacts. By default, a maximum of ten contacts are shown per page.

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?keyword=' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "total": 65,
    "page": 1,
    "pageSize": 10,
    "lastPage": 7,
    "data": [
        {
            "id": "eefdaf75-ed19-4291-8e47-913f1205d02d",
            "name": "Aria ",
            "address": "Dagon Seikkan Township",
            "channel": "phone",
            "notes": null,
            "socialProfileUrl": null,
            "tags": [
                {
                    "id": "258fc2c9-738d-4889-806c-0955a3b892c3",
                    "name": "platinum"
                }
            ],
            "company": {
                "id": "5073bd60-dee4-4866-a798-42c37300171c",
                "name": "Cool Entreprise",
                "phone": null,
                "address": null,
                "industry": null
            },
            "contactEmails": [
                {
                    "email": "mistercustomer@gmail.com",
                    "isPrimary": false
                }
            ],
            "contactPhones": [
                {
                    "phone": "09797877765",
                    "isPrimary": true
                }
            ],
            "customFields": [
                {
                    "system_name": "cf_sector",
                    "display_name": "sector`",
                    "type": "text",
                    "value": "Finance"
                }
            ]
        }
    ]
}
Modified at 2026-01-08 17:29:53
Previous
Webhook Events and Schema
Next
Create
Built with