Contacts
Search Contacts
get/api/v1/accounts/{account_id}/contacts/search
Request
- Base URLhttp://localhost:3000
- AuthAPI key in header api_access_token
Path parameters
account_idinteger required
Query parameters
qstring required
Search query
pageinteger
Page number
Response
Success
metaobject
current_pagestring
payloadobject[]
additional_attributesobject
emailstring
idstring
namestring
phone_numberstring
identifierstring
thumbnailstring
custom_attributesobject
last_activity_atstring date-time
created_atstring date-time
blockedboolean
contact_inboxesobject
source_idstring
inboxobject
avatar_urlstring
channel_idstring
channel_typestring
greeting_enabledstring
greeting_messagestring
working_hours_enabledstring
enable_email_collectstring
csat_survey_enabledstring
follow_up_enabledstring
follow_up_afterstring
follow_up_message_contentstring
enable_auto_assignmentstring
auto_assignment_configstring
out_of_office_messagestring
working_hoursstring
timezonestring
callback_webhook_urlstring
allow_messages_after_resolvedstring
create_conversation_via_apistring
lock_to_single_conversationstring
sender_name_typestring
business_namestring
enable_multi_conversationstring
help_centerobject
slugstring
tweets_enabledstring
widget_colorstring
website_urlstring
hmac_mandatorystring
allowed_domainsstring
welcome_titlestring
welcome_taglinestring
web_widget_scriptstring
web_widget_advanced_scriptstring
web_widget_script_with_user_identifier_hmacstring
website_tokenstring
selected_feature_flagsstring
reply_timestring
hmac_tokenstring
pre_chat_form_enabledstring
pre_chat_form_optionsstring
continuity_via_emailstring
continuity_channel_idstring
widget_localestring
page_idstring
reauthorization_requiredstring
messaging_service_sidstring
mediumstring
forward_to_emailstring
imap_loginstring
imap_passwordstring
imap_addressstring
imap_portstring
imap_enabledstring
imap_enable_sslstring
smtp_loginstring
smtp_passwordstring
smtp_addressstring
smtp_portstring
smtp_enabledstring
smtp_domainstring
smtp_enable_ssl_tlsstring
smtp_enable_starttls_autostring
smtp_openssl_verify_modestring
smtp_authenticationstring
webhook_urlstring
inbox_identifierstring
providerstring
message_templatesstring
provider_configstring
integrated_csatstring
consider_proactive_messagesstring
integration_statusstring
email_swap_channel_idstring
enable_swap_to_email_channelstring
dm_enabledstring
comments_enabledstring
stories_enabledstring
human_agent_enabledstring
human_agent_activestring
Changes
No recorded changes to this operation across all 1 revision of this API.