List Contacts
wa_list_contactsList the address book of one of your WhatsApp accounts — the contacts saved on the phone this account is linked to. Use the returned phone numbers with wa_send_message. To find a specific person, use wa_search_contacts instead. Set include_pictures to also get each contact's profile picture URL; that looks the contacts up on WhatsApp, so it returns at most 10 per page and is slower.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | how many to return (default 500, max 2000; max 10 with include_pictures) | |
| account_id | Yes | which of your accounts to read, from wa_list_accounts | |
| after_cursor | No | return contacts after this cursor; omit to start from the beginning | |
| include_pictures | No | also return each contact's profile picture URL. This looks every contact on the page up on WhatsApp, so the page is capped at 10 and can take half a minute; leave it off for a fast listing |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| note | No | ||
| total | Yes | how many contacts matched in total, before the limit was applied | |
| refusal | No | present only when the request was declined | |
| contacts | Yes | ||
| has_more | No | true when more contacts remain after this page | |
| truncated | No | true when more contacts exist than were returned | |
| next_cursor | No | pass this as after_cursor to continue; page until has_more is false to read the whole address book |