Read Hive automation contacts
read_contactsRead-onlyIdempotent
List the people this Hive workspace has spoken to through DM automation, sequences, broadcasts and the Inbox. Names, handles and stored values follow the workspace Inbox privacy setting, so they may come back masked. The included-contact allowance comes back with every answer.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Find people by exact email address. Use only one of email, phone or fieldId. | ||
| limit | No | How many people to return, 1 to 100. Defaults to 25. | |
| phone | No | Find people by exact phone number in international format, like +14155550123. | |
| search | No | Match a name, handle or provider id. | |
| fieldId | No | Find people whose contact field has exactly fieldValue. Field ids come from read_contact_fields. | |
| accountId | No | Only people on this connected account’s platform. | |
| fieldName | No | The field’s key or name, instead of fieldId. | |
| segmentId | No | Only people in this Hive segment. | |
| fieldValue | No | The value to match in fieldId. |