Search Contacts

POSThttps://services.leadconnectorhq.com/contacts/search

Search contacts based on combinations of advanced filters. Documentation Link - HERE

Request

Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

Provide your bearer token in the Authorization header when making requests to protected resources.

Example: Authorization: Bearer 123
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-04-15

Responses

Successful response

Body

contacts
array[object]
required
id
string
Example:
102goXVW3lIExEQPOnd3
phoneLabel
string
Example:
Mobile
country
string
Example:
United States
address
string
Example:
123 Main Street
source
string
Example:
Website
type
string
Example:
lead
locationId
string
Example:
502goXVW3lIExEQPOnd3
dnd
boolean
Example:
false
state
string
Example:
California
businessName
string
Example:
Acme Corporation
customFields
array[object]
tags
array[string]
Example:
["tag-1","tag-2"]
dateAdded
string
Example:
2024-06-06T18:54:57.221Z
additionalEmails
array[string]
Example:
["john@example.com","jane@example.com"]
phone
string
Example:
+123456789
companyName
string
Example:
XYZ Corp
additionalPhones
array[string]
Example:
["123456789","987654321"]
dateUpdated
string
Example:
2024-06-06T18:54:57.221Z
city
string
Example:
New York
dateOfBirth
string
Example:
1990-01-01
firstNameLowerCase
string
Example:
john
lastNameLowerCase
string
Example:
doe
email
string
Example:
john@example.com
assignedTo
string
Example:
182goXVW3lIExEQPOnd3
followers
array[string]
Example:
["682goXVW3lIExEQPOnd3","582goXVW3lIExEQPOnd3"]
validEmail
boolean
Example:
true
dndSettings
object
Call
object
status
string
required
Allowed values:
activeinactivepermanent
message
string
code
string
Email
object
status
string
required
Allowed values:
activeinactivepermanent
message
string
code
string
SMS
object
status
string
required
Allowed values:
activeinactivepermanent
message
string
code
string
WhatsApp
object
status
string
required
Allowed values:
activeinactivepermanent
message
string
code
string
GMB
object
status
string
required
Allowed values:
activeinactivepermanent
message
string
code
string
FB
object
status
string
required
Allowed values:
activeinactivepermanent
message
string
code
string
opportunities
array[object]
id
string
required
Example:
1a2b3c4d5e6f7g8h9i0j
pipeline_id
string
required
Example:
pipeline123
pipeline_stage_id
string
required
Example:
stage456
monetary_value
number
required
Example:
10000
status
string
required
Example:
open
postalCode
string
Example:
12345
businessId
string
Example:
282goXVW3lIExEQPOnd3
searchAfter
array[string]
Example:
[1234,"102goXVW3lIExEQPOnd3"]
total
number
required
Example:
120

Unprocessable Entity

Body

statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity

Unauthorized

Body

statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized

Bad Request

Body

statusCode
number
Example:
400
message
string
Example:
Bad Request