List an inbox's contacts
list_contactsList the people this number has exchanged messages with.
Filter by phone or by name. They are separate filters, not one
search box: name matches the contact's name, phone matches the
number.
source restricts to how the contact first appeared: inbound (they
messaged this number), outbound (this number messaged them),
mention (named in a group message) or self (the number's own
contact card).
contacted_in_cycle=true narrows the list to exactly the people
counting against this number's contact quota this billing cycle: those
messaged through Turbo Notify inside the cycle, whether newly or again.
Use it to see what the quota gauge is actually counting.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Only contacts whose name matches. | |
| limit | No | How many items to return, 1-200. Defaults to 50. | |
| phone | No | Only contacts whose phone number matches. | |
| cursor | No | Opaque cursor for the next page. Pass back the `cursor` from the previous response, with the same filters; omit it for the first page. | |
| source | No | Only contacts that first appeared this way: `inbound` (they messaged this number), `outbound` (this number messaged them), `mention` (named in a group message) or `self` (the number's own contact card). | |
| number_alias | No | Which of the organization's WhatsApp numbers this acts on: `main`, the alias of an extra number, or the number's `id` (`num_…`), which stays the same when the alias is renamed. Call `list_numbers` to see them. Defaults to the main number. | main |
| contacted_in_cycle | No | When true, return only the people who count against this number's contact quota in the current billing cycle: those messaged through Turbo Notify inside the cycle, new or returning. Use it to see exactly what the quota figure is counting. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||