Search Users

get
https://services.leadconnectorhq.com/users/search
Search Users
Request

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

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
Query Parameters
enabled2waySync
boolean
ids
string

List of User IDs to be filtered in the search

Examples:
5DP4iH6HLkQsiKESj6rh,5DP4iH6HLkQsiKESj34h
limit
string

No of results to be limited before returning the result

Default:
25
Examples:
10
locationId
string

Location ID in which the search needs to be performed

Examples:
5DP41231LkQsiKESj6rh
query
string

The search term for the user is matched based on the user full name, email or phone

Examples:
John
role
string

Role of the users to be filtered in the search

Examples:
admin
skip
string

No of results to be skipped before returning the result

Default:
0
Examples:
1
sort
string

The field on which sort is applied in which the results need to be sorted. Default is based on the first and last name

Examples:
dateAdded
sortDirection
string

The direction in which the results need to be sorted

Examples:
asc
type
string

Type of the users to be filtered in the search

Examples:
agency
companyId
string
required

Company ID in which the search needs to be performed

Examples:
5DP41231LkQsiKESj6rh
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
users
array[object]
id
string
Example:
0IHuJvc2ofPAAA8GzTRi
name
string
Example:
John Deo
firstName
string
Example:
John
lastName
string
Example:
Deo
email
string
Example:
john@deo.com
phone
string
Example:
+1 808-868-8888
extension
string
Example:
permissions
object
scopes
string
Allowed values:
campaigns.readonlycampaigns.writecalendars/events.writecalendars/events.readonlycontacts.writecontacts/bulkActions.writeworkflows.readonlyworkflows.writetriggers.writefunnels.writewebsites.writemedias.writemedias.readonlyopportunities.writeopportunities/leadValue.readonlyopportunities/bulkActions.writereporting/phone.readonlyreporting/adwords.readonlyreporting/facebookAds.readonlyreporting/attributions.readonlyreporting/agent.readonlyreporting/reports.writereporting/reports.readonlypayments.writepayments/refunds.writepayments/records.writepayments/exports.writepayments/subscriptionsCancel.writeinvoices.writeinvoices.readonlyinvoices/schedule.readonlyinvoices/schedule.writeinvoices/template.readonlyinvoices/template.writereputation/review.writereputation/listing.writeconversations.writeconversations.readonlyconversations/message.readonlyconversations/message.writecontentAI.writedashboard/stats.readonlylocations/tags.writelocations/tags.readonlymarketing.writeeliza.writesettings.writesocialplanner/post.writesocialplanner/account.readonlysocialplanner/account.writesocialplanner/category.readonlysocialplanner/category.writesocialplanner/csv.readonlysocialplanner/csv.writesocialplanner/group.writesocialplanner/hashtag.readonlysocialplanner/hashtag.writesocialplanner/oauth.readonlysocialplanner/oauth.writesocialplanner/post.readonlysocialplanner/recurring.readonlysocialplanner/recurring.writesocialplanner/review.readonlysocialplanner/review.writesocialplanner/rss.readonlysocialplanner/rss.writesocialplanner/search.readonlysocialplanner/setting.readonlysocialplanner/setting.writesocialplanner/stat.readonlysocialplanner/tag.readonlysocialplanner/tag.writesocialplanner/filters.readonlysocialplanner/medias.readonlysocialplanner/medias.writesocialplanner/watermarks.readonlysocialplanner/watermarks.writesocialplanner/metatag.readonlysocialplanner/facebook.readonlysocialplanner/linkedin.readonlysocialplanner/twitter.readonlysocialplanner/notification.readonlysocialplanner/notification.writesocialplanner/snapshot.readonlysocialplanner/snapshot.writemarketing/affiliate.writeblogs.writemembership.writecommunities.writecertificates.writecertificates.readonlyadPublishing.writeadPublishing.readonlyprospecting.writeprospecting.readonlyprospecting/reports.readonlyprivate-integration-location.readonlyprivate-integration-location.writeprivate-integration-company.readonlyprivate-integration-company.writenative-integrations.readonlynative-integrations.writewordpress.writewordpress.readcustom-menu-link.writeusers/team-management.writeusers/team-management.readonly
roles
object
type
string
Example:
account
role
string
Example:
admin
locationIds
array[string]
Example:
["ve9EPM428h8vShlRW1KT"]
restrictSubAccount
boolean
Example:
true
deleted
boolean
Example:
false
lcPhone
object

LC Phone Inbound Phone Numbers

Example:
{"locationId":"+1234556677"}
count
number
Example:
1231

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