Contacts

List contacts

List contacts attached to the WhatsApp account identified by phone_number_id. Filter by exact phone (E.164) or partial search (matches name and email).

get/{phone_number_id}/contacts

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/contacts
  • Auth: HTTP bearer

Path parameters

phone_number_idstring required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

Example:106540352242922

Query parameters

phonestring

Exact phone-number match. Common E.164 formatting is accepted and normalized.

Example:+628123456789
bsuidstring

Exact Meta Business-Scoped User ID match.

Example:US.13491208655302741918
usernamestring

Exact WhatsApp username match, compared case-insensitively.

Example:pablomorales
searchstring

Case-insensitive substring search across contact name and email.

Example:Budi
limitstring

Number of items to return. Defaults to 25; minimum 1 and maximum 100.

Example:25
cursorstring

Opaque continuation token from the previous response's next_cursor. Pass it unchanged and keep all other filters the same.

Example:eyJpZCI6IjAxSFhZWkFCQ0RFRkdISktNTlBRUlNUVldYIiwidHMiOiIyMDI2LTA5LTEwVDA5OjAwOjAwLjAwMFoifQ

Response

Contact list

has_moreboolean required

Whether another page is available.

next_cursorstring nullable required

Pass this value unchanged as cursor to fetch the next page. null marks the final page.

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": [
    {
      "id": "ctc_01HXYZABCDEFGHJKMNPQRSTVWX",
      "phone_number": "+628123456789",
      "bsuid": "US.13491208655302741918",
      "parent_bsuid": "US.ENT.11815799212886844830",
      "username": "pablomorales",
      "labels": [
        {
          "id": "lbl_01HXYZABCDEFGHJKMNPQRSTVWX",
          "name": "VIP"
        }
      ],
      "whatsapp_account": {
        "phone_number_id": "106540352242922",
        "customer": {
          "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
        }
      }
    }
  ],
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.