Contacts
Search Contacts
Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
get/api/v1/accounts/{account_id}/contacts/search
Request
- Base URLhttps://app.hoory.com
- AuthAPI key in header api_access_token
Path parameters
account_idinteger required
The numeric ID of the account
Query parameters
qstring
Search using contact name, identifier, email or phone number
sort'name' | 'email' | 'phone_number' | 'last_activity_at' | '-name' | '-email' | '-phone_number' | '-last_activity_at'
The attribute by which list should be sorted
pageinteger
The page parameter
Response
Success
Example response
{
"payload": [
{
"payload": {
"contact": {
"custom_attributes": {
"attribute_key": "attribute_value",
"signed_up_at": "dd/mm/yyyy"
}
}
}
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.