List address book contacts
notifyre_list_contactsRead-only
Search the address book. search_query matches the name; type FaxNumber or MobileNumber keeps contacts that have that number; group_ids limits to groups. Page numbers start at 0. Contacts that unsubscribed are left out unless include_unsubscribed is true. The unsubscribe key of a contact is never shown. Notifyre API: POST /addressbook/contacts/search (a read).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number, from 0 (default 0). | |
| type | No | Only contacts that have this kind of number. | |
| limit | No | Page size, 1 to 100 (default 20). | |
| sort_by | No | Sort field (default name). | |
| sort_dir | No | asc or desc (default asc). | |
| group_ids | No | Only contacts in these group ids. | |
| search_query | No | Text in the contact's name. | |
| include_unsubscribed | No | Also return contacts that unsubscribed (default false). |