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.

post/api/v1/tools/read_contacts

Request

  • Base URL: https://hivepublish.com
  • URL: https://hivepublish.com/api/v1/tools/read_contacts
  • Auth: HTTP bearer

Request body

segmentIdstring

Only people in this Hive segment.

searchstring

Match a name, handle or provider id.

accountIdstring

Only people on this connected account’s platform.

emailstring

Find people by exact email address. Use only one of email, phone or fieldId.

phonestring

Find people by exact phone number in international format, like +14155550123.

fieldIdstring

Find people whose contact field has exactly fieldValue. Field ids come from read_contact_fields.

fieldNamestring

The field’s key or name, instead of fieldId.

limitinteger

How many people to return, 1 to 100. Defaults to 25.

Response

Tool result

dataunknown required

Changes

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