Search contacts

Contacts the key's creator can see, most recently updated first.

Numbers are masked when the key creator's role masks them.

Key: kf_live_ / kf_test_… in the Authorization: Bearer header. Created in Settings › API & Webhook › Create key (Pengaturan › API & Webhook › Buat kunci).
Key scope: contacts:read
Plan feature: WhatsApp sending API

Query parameters

searchstring
Search name, number, email, company, or city.
limitinteger
1–100, default 25.
cursorstring
next_cursor from the previous page.

Possible errors

400 cursor_invalid Invalid cursor
401 missing_key API key not sent
401 key_invalid Unknown API key
401 key_revoked API key revoked
401 key_expired API key expired
401 member_inactive Key creator is no longer a member
403 ip_not_allowed Server IP not in the key's list
403 plan_no_api Plan does not include the API for live keys
403 tenant_blocked Business access suspended
403 scope_missing Key lacks this permission
403 permission_missing Key creator's role lacks this permission
429 rate_limited Too many requests per minute
500 internal_error Problem at Klik Flow

Try it

Try it with a test key

Test API keyTest keys only (kf_test_…), kept in this tab only and sent only to this site's API.

Query parameterssearchlimitcursor

/api/v2/contacts

Request example

curl -X GET "https://klikflow.id/api/v2/contacts?search=rina" \
  -H "Authorization: Bearer KUNCI_API"

Response example 200

{
  "data": [
    {
      "id": 301,
      "object": "contact",
      "name": "Rina",
      "phone": "6281234567890",
      "email": "rina@contoh.com",
      "company": null,
      "city": "Bandung",
      "source_channel": "whatsapp",
      "custom_fields": {
        "member": "Gold"
      },
      "created_at": "2026-10-01T03:00:00.000Z",
      "updated_at": "2026-11-01T02:10:00.000Z"
    }
  ],
  "next_cursor": null
}

Query parameters

Possible errors

Try it

Send WhatsApp from your system with the Klik Flow API.