Get Contacts By BusinessId
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
Provide your bearer token in the Authorization header when making requests to protected resources.
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-04-15
Path Parameters
businessId
stringQuery Parameters
limit
stringDefault:
25
Example:
10
query
stringExample:
contact name
skip
stringDefault:
0
Example:
10
locationId
stringExample:
5DP4iH6HLkQsiKESj6rh
Responses
200
Successful response
Body
contacts
array[object]id
stringExample:
ocQHyuzHvysMo5N5VsXc
locationId
stringExample:
C2QujeCh8ZnC7al2InWR
email
stringExample:
JohnDeo@gmail.com
timezone
stringExample:
Asia/Calcutta
country
stringExample:
DE
source
stringExample:
xyz form
dateAdded
stringExample:
2020-10-29T09:31:30.255Z
customFields
array[object]id
stringExample:
MgobCB14YMVKuE4Ka8p1
value
stringExample:
name
tags
array[string]Example:
["nisi sint commodo amet","consequat"]
businessId
stringExample:
641c094001436dbc2081e642
attributions
array[object]url
stringExample:
Trigger Link
campaign
string or null
utmSource
string or null
utmMedium
string or null
utmContent
string or null
referrer
string or null
Example:
https: //www.google.com
campaignId
string or null
fbclid
string or null
gclid
string or null
Example:
CjOKCQjwnNyUBhCZARISAI9AYIFtNnIcWcYGIOQINz_ZoFI5SSLRRugSoPZoiEu27IZBY£1-MAIWmEaAo2VEALW_WCB
msclikid
string or null
dclid
string or null
fbc
string or null
fbp
string or null
Example:
fb. 1.1674748390986.1171287961
fbEventId
string or null
Example:
Mozilla/5.0
userAgent
string or null
Example:
Mozilla/5.0
ip
string or null
Example:
58.111.106.198
medium
string or null
Example:
survey
mediumId
string or null
Example:
FglfHAn30PRwsZVyQlKp
followers
array[string]Example:
641c094001436dbc2081e642
count
numberExample:
10
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request