Search

get
https://services.leadconnectorhq.com/locations/search
Search Sub-Account (Formerly Location)

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

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

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

Example: Authorization: Bearer 123
Query Parameters
companyId
string

The company/agency id on which you want to perform the search

Examples:
5DP4iH6HLkQsiKESj6rh
email
string
Examples:
johndoe@mail.com
limit
string

The value by which the results should be limited. Default will be 10

Default:
10
Examples:
10
order
string

The order in which the results should be returned - Allowed values asc, desc. Default will be asc

Default:
asc
Examples:
asc
skip
string

The value by which the results should be skipped. Default will be 0

Default:
0
Examples:
1
Headers
Authorization
string
required

Access Token

Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
string
required

API Version

Allowed value:
2021-07-28

Responses

Successful response

Body

responses
/
200
locations
array[object]
id
string

Location Id

Example:
ve9EPM428h8vShlRW1KT
name
string

The name for the sub-account/location

Example:
Mark Shoes
phone
string

The phone number of the business for which sub-account is created

Example:
+1410039940
email
string

The email for the sub-account/location

Example:
john.doe@mail.com
address
string

The address of the business for which sub-account is created

Example:
4th fleet street
city
string

The city where the business is located for which sub-account is created

Example:
New York
state
string

The state in which the business operates for which sub-account is created

Example:
Illinois
country
string

The country in which the business is present for which sub-account is created

Example:
US
postalCode
string

The postal code of the business for which sub-account is created

Example:
567654
website
string

The website of the business for which sub-account is created

Example:
https://yourwebsite.com
timezone
string

The timezone of the business for which sub-account is created

Example:
US/Central
settings
object

The default settings for location

allowDuplicateContact
boolean
Example:
false
allowDuplicateOpportunity
boolean
Example:
false
allowFacebookNameMerge
boolean
Example:
false
disableContactTimezone
boolean
Example:
false
social
object

The social media links for location

facebookUrl
string

Facebook URL

Example:
https://www.facebook.com/
googlePlus
string

Googleplus URL

Example:
https://www.googleplus.com/
linkedIn
string

LinkedIn URL

Example:
https://www.linkedIn.com/
foursquare
string

Foursquare URL

Example:
https://www.foursquare.com/
twitter
string

Twitter URL

Example:
https://www.foutwitterrsquare.com/
yelp
string

Yelp URL

Example:
https://www.yelp.com/
instagram
string

Instagram URL

Example:
https://www.instagram.com/
youtube
string

Instagram URL

Example:
https://www.youtube.com/
pinterest
string

Instagram URL

Example:
https://www.pinterest.com/
blogRss
string

Instagram URL

Example:
https://www.blogRss.com/
googlePlacesId
string

Google Business Places ID

Example:
ChIJJGPdVbQTrjsRGUkefteUeFk

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