klink-developers-logo

Contact

Filter By Phone Number

GET/api/v1/contacts/phone/{phone}

Retrieve a single contact by phone number.

The number is compared digits-only: a leading +, spaces, dashes and brackets in your input are ignored, and every phone stored on a contact is compared the same way. So +959123456789, 959123456789 and 959-123-456-789 all resolve to the same contact. WhatsApp contacts are stored as the international number without + (the WhatsApp ID); contacts created from calls or entered manually are stored as typed.

When several contacts share the number, the one where it is the primary phone is returned, then the most recently created.

Returns the same object as Detail (GET /api/v1/contacts/{id}), including platformContacts and their rooms/channels.

  • 404 — no contact holds that number.
  • 400 — the value is not a phone number (must contain digits; only +, spaces, dashes and brackets are allowed around them).

Request

Authorization

Bearer Token

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

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

Path Params
  • phonestringrequired

    Phone number. Digits with an optional leading +, spaces, dashes or brackets. Compared digits-only.

    Example:959123456789

Responses

200

OK

  • 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
400

Bad Request

  • statusCodeintegeroptional
  • messagearray[string]optional
  • errorstringoptional
404

Not Found

  • statusCodeintegeroptional
  • messagestringoptional
  • errorstringoptional