Find contacts by email, phone, or a field and its value
Runs read_contacts with the same scope, permission and approval rules.
get/api/v1/contacts
Request
- Base URL: https://hivepublish.com
- URL: https://hivepublish.com/api/v1/contacts
- Auth: HTTP bearer
Query parameters
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.
fieldValuestring
The value to match in fieldId.
limitinteger
How many people to return, 1 to 100. Defaults to 25.
Response
Tool result
Changes
No recorded changes to this operation across all 1 revision of this API.