Contacts
v1
Search Contacts
Search for contacts based on the provided search parameters and returns contact summary objects. Credit Note: Searches do not consume credits. Credits are only used if you subsequently retrieve deep data for a contact that has not been accessed within the last 12 months.
:::info Requires the contacts:read OAuth2 scope. :::
post/v1/contacts/search
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
page[cursor]string
Cursor for pagination. Use this value to fetch the next page of results.
page[size]integer
The number of items per page. Maximum is 100.
Request body
Example request
{
"search_terms": [
"John Doe"
],
"positions": [
"CEO",
"CTO"
],
"emails": [
"john.doe@example.com"
],
"company_ids": [
"129011",
"159001425"
],
"departments": [
"marketing_department",
"students_apprentices"
],
"hierarchy_levels": [
"top_management",
"middle_management"
],
"affiliation": "employee",
"buyer_persona_ids": [
"7421",
"7422"
],
"company_locations": [
{
"city": "Naples",
"country_code": "IT"
},
{
"city": "Berlin",
"country_code": "DE"
}
],
"phones": [
"+4972150057501",
"+4972150057209"
]
}Response
Success
Example response
{
"data": [
{
"type": "contact_summary",
"id": "435834",
"attributes": {
"full_name": "John Doe",
"gender": "male",
"hierarchy_level": "employees",
"meta": {
"has_phones": true,
"has_mail": true,
"has_social_accounts": true
}
},
"relationships": {
"company": {
"id": "129011"
}
}
}
],
"meta": {
"pagination": {
"next_cursor": "dXNlcjpVMEc5V0ZYTlo",
"total_count": 1450
},
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}