Source: HighLevel API 2.0 Documentation Crawled: 2026-03-25
- Users
- Create User
- Filter Users By Email
- Get User
- Get User By Location
- Search
- Search Users
- Update User
Source: https://marketplace.gohighlevel.com/docs/ghl/users/users/index.html
Documentation for users API
📄️ Get User \ Get User📄️ Update User \ Update User📄️ Delete User \ Delete User📄️ Get User by Location \ Get User by Location📄️ Create User \ Create User
Source: https://marketplace.gohighlevel.com/docs/ghl/users/create-user/index.html
POST https://services.leadconnectorhq.com/users/
Create User
users.write
OAuth Access Token``Private Integration Token
Agency Token``Sub-Account Token
Request
Version stringrequired
Possible values: [2021-07-28]
API Version
- application/json
companyId stringrequired
Example:ve9EPM428h8vShlRW1KT
firstName stringrequired
Example:John
lastName stringrequired
Example:Deo
email stringrequired
Example:john@deo.com
password stringrequired
Example:*******
phone string
Example:+18832327657
type stringrequired
Example:account
role stringrequired
Example:admin
locationIds string[]required
Example:["C2QujeCh8ZnC7al2InWR"]
permissions object
campaignsEnabled boolean
Default value: true
Example:true
campaignsReadOnly boolean
Default value: false
Example:false
contactsEnabled boolean
Default value: true
Example:true
workflowsEnabled boolean
Default value: true
Example:true
workflowsReadOnly boolean
Default value: false
Example:true
triggersEnabled boolean
Default value: true
Example:true
funnelsEnabled boolean
Default value: true
Example:true
websitesEnabled boolean
Default value: false
Example:false
opportunitiesEnabled boolean
Default value: true
Example:true
dashboardStatsEnabled boolean
Default value: true
Example:true
bulkRequestsEnabled boolean
Default value: true
Example:true
appointmentsEnabled boolean
Default value: true
Example:true
reviewsEnabled boolean
Default value: true
Example:true
onlineListingsEnabled boolean
Default value: true
Example:true
phoneCallEnabled boolean
Default value: true
Example:true
conversationsEnabled boolean
Default value: true
Example:true
assignedDataOnly boolean
Default value: false
Example:false
adwordsReportingEnabled boolean
Default value: false
Example:false
membershipEnabled boolean
Default value: false
Example:false
facebookAdsReportingEnabled boolean
Default value: false
Example:false
attributionsReportingEnabled boolean
Default value: false
Example:false
settingsEnabled boolean
Default value: true
Example:true
tagsEnabled boolean
Default value: true
Example:true
leadValueEnabled boolean
Default value: true
Example:true
marketingEnabled boolean
Default value: true
Example:true
agentReportingEnabled boolean
Default value: true
Example:true
botService boolean
Default value: false
Example:false
socialPlanner boolean
Default value: true
Example:true
bloggingEnabled boolean
Default value: true
Example:true
invoiceEnabled boolean
Default value: true
Example:true
affiliateManagerEnabled boolean
Default value: true
Example:true
contentAiEnabled boolean
Default value: true
Example:true
refundsEnabled boolean
Default value: true
Example:true
recordPaymentEnabled boolean
Default value: true
Example:true
cancelSubscriptionEnabled boolean
Default value: true
Example:true
paymentsEnabled boolean
Default value: true
Example:true
communitiesEnabled boolean
Default value: true
Example:true
exportPaymentsEnabled boolean
Default value: true
Example:true
scopes string[]
Scopes allowed for users. Only scopes that have been passed will be enabled. Note:- If passed empty all the scopes will be get disabled
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
Example:["contacts.write","campaigns.readonly"]
scopesAssignedToOnly string[]
Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
Example:["contacts.write","campaigns.readonly"]
profilePhoto string
Example:https://img.png
platformLanguage string
Platform language preference for the user
Possible values: [en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no]
Example:en_US
Responses
- 201
- 400
- 401
- 422
Successful response
-
application/json
-
Schema
-
Example (auto)
Schema
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
campaignsEnabled boolean
Default value: true
Example:true
campaignsReadOnly boolean
Default value: false
Example:false
contactsEnabled boolean
Default value: true
Example:true
workflowsEnabled boolean
Default value: true
Example:true
workflowsReadOnly boolean
Default value: false
Example:true
triggersEnabled boolean
Default value: true
Example:true
funnelsEnabled boolean
Default value: true
Example:true
websitesEnabled boolean
Default value: false
Example:false
opportunitiesEnabled boolean
Default value: true
Example:true
dashboardStatsEnabled boolean
Default value: true
Example:true
bulkRequestsEnabled boolean
Default value: true
Example:true
appointmentsEnabled boolean
Default value: true
Example:true
reviewsEnabled boolean
Default value: true
Example:true
onlineListingsEnabled boolean
Default value: true
Example:true
phoneCallEnabled boolean
Default value: true
Example:true
conversationsEnabled boolean
Default value: true
Example:true
assignedDataOnly boolean
Default value: false
Example:false
adwordsReportingEnabled boolean
Default value: false
Example:false
membershipEnabled boolean
Default value: false
Example:false
facebookAdsReportingEnabled boolean
Default value: false
Example:false
attributionsReportingEnabled boolean
Default value: false
Example:false
settingsEnabled boolean
Default value: true
Example:true
tagsEnabled boolean
Default value: true
Example:true
leadValueEnabled boolean
Default value: true
Example:true
marketingEnabled boolean
Default value: true
Example:true
agentReportingEnabled boolean
Default value: true
Example:true
botService boolean
Default value: false
Example:false
socialPlanner boolean
Default value: true
Example:true
bloggingEnabled boolean
Default value: true
Example:true
invoiceEnabled boolean
Default value: true
Example:true
affiliateManagerEnabled boolean
Default value: true
Example:true
contentAiEnabled boolean
Default value: true
Example:true
refundsEnabled boolean
Default value: true
Example:true
recordPaymentEnabled boolean
Default value: true
Example:true
cancelSubscriptionEnabled boolean
Default value: true
Example:true
paymentsEnabled boolean
Default value: true
Example:true
communitiesEnabled boolean
Default value: true
Example:true
exportPaymentsEnabled boolean
Default value: true
Example:true
scopes string
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
roles object
type string
Example:account
role string
Example:admin
locationIds string[]
Example:["ve9EPM428h8vShlRW1KT"]
restrictSubAccount boolean
Example:true
lcPhone object
LC Phone Inbound Phone Numbers
Example:{"locationId":"+1234556677"}
platformLanguage string
Platform language preference for the user
Possible values: [en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no]
Example:en_US
{
"id": "0IHuJvc2ofPAAA8GzTRi",
"name": "John Deo",
"firstName": "John",
"lastName": "Deo",
"email": "john@deo.com",
"phone": "+1 808-868-8888",
"extension": "",
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": "campaigns.readonly",
"roles": {
"type": "account",
"role": "admin",
"locationIds": [\
"ve9EPM428h8vShlRW1KT"\
],
"restrictSubAccount": true
},
"lcPhone": {
"locationId": "+1234556677"
},
"platformLanguage": "en_US"
}Bad Request
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:400
message string
Example:Bad Request
{
"statusCode": 400,
"message": "Bad Request"
}Unauthorized
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}Unprocessable Entity
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:422
message string[]
Example:["Unprocessable Entity"]
error string
Example:Unprocessable Entity
{
"statusCode": 422,
"message": [\
"Unprocessable Entity"\
],
"error": "Unprocessable Entity"
}name: Authorizationtype: httpscopes: users.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
-
curl
-
nodejs
-
python
-
php
-
java
-
go
-
ruby
-
powershell
-
CURL
curl -L 'https://services.leadconnectorhq.com/users/' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"companyId": "ve9EPM428h8vShlRW1KT",
"firstName": "John",
"lastName": "Deo",
"email": "john@deo.com",
"password": "*******",
"phone": "+18832327657",
"type": "account",
"role": "admin",
"locationIds": [\
"C2QujeCh8ZnC7al2InWR"\
],
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": [\
"contacts.write",\
"campaigns.readonly"\
],
"scopesAssignedToOnly": [\
"contacts.write",\
"campaigns.readonly"\
],
"profilePhoto": "https://img.png",
"platformLanguage": "en_US"
}'Request Collapse all
Base URL
Edit
https://services.leadconnectorhq.com
Auth
Security Scheme
Agency-AccessLocation-Access
Bearer Token
Parameters
Version — headerrequired
---2021-07-28
Body required
{
"companyId": "ve9EPM428h8vShlRW1KT",
"firstName": "John",
"lastName": "Deo",
"email": "john@deo.com",
"password": "*******",
"phone": "+18832327657",
"type": "account",
"role": "admin",
"locationIds": [\
"C2QujeCh8ZnC7al2InWR"\
],
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": [\
"contacts.write",\
"campaigns.readonly"\
],
"scopesAssignedToOnly": [\
"contacts.write",\
"campaigns.readonly"\
],
"profilePhoto": "https://img.png",
"platformLanguage": "en_US"
}Send API Request
ResponseClear
Click the Send API Request button above and see the response here!
Source: https://marketplace.gohighlevel.com/docs/ghl/users/filter-users-by-email/index.html
POST https://services.leadconnectorhq.com/users/search/filter-by-email
Filter users by company ID, deleted status, and email array
users.readonly
OAuth Access Token``Private Integration Token
Agency Token
Request
Version stringrequired
Possible values: [2021-07-28]
API Version
- application/json
companyId stringrequired
Company ID to filter users
Example:5DP41231LkQsiKESj6rh
emails stringrequired
Comma-separated list of email addresses to filter users
Example:user1@example.com,user2@example.com
deleted boolean
Filter deleted users
Default value: false
Example:false
skip string
No of results to be skipped before returning the result
Default value: 0
Example:1
limit string
No of results to be limited before returning the result
Default value: 25
Example:10
projection string
Projection fields to return. Use "all" for all fields, or specify comma-separated field names. Default returns only id and email
Example:all
Responses
- 200
- 400
- 401
- 422
Successful response
-
application/json
-
Schema
-
Example (auto)
Schema
users object[]
Array [
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
campaignsEnabled boolean
Default value: true
Example:`true`
campaignsReadOnly boolean
Default value: `false`
Example:`false`
contactsEnabled boolean
Default value: `true`
Example:`true`
workflowsEnabled boolean
Default value: `true`
Example:`true`
workflowsReadOnly boolean
Default value: `false`
Example:`true`
triggersEnabled boolean
Default value: `true`
Example:`true`
funnelsEnabled boolean
Default value: `true`
Example:`true`
websitesEnabled boolean
Default value: `false`
Example:`false`
opportunitiesEnabled boolean
Default value: `true`
Example:`true`
dashboardStatsEnabled boolean
Default value: `true`
Example:`true`
bulkRequestsEnabled boolean
Default value: `true`
Example:`true`
appointmentsEnabled boolean
Default value: `true`
Example:`true`
reviewsEnabled boolean
Default value: `true`
Example:`true`
onlineListingsEnabled boolean
Default value: `true`
Example:`true`
phoneCallEnabled boolean
Default value: `true`
Example:`true`
conversationsEnabled boolean
Default value: `true`
Example:`true`
assignedDataOnly boolean
Default value: `false`
Example:`false`
adwordsReportingEnabled boolean
Default value: `false`
Example:`false`
membershipEnabled boolean
Default value: `false`
Example:`false`
facebookAdsReportingEnabled boolean
Default value: `false`
Example:`false`
attributionsReportingEnabled boolean
Default value: `false`
Example:`false`
settingsEnabled boolean
Default value: `true`
Example:`true`
tagsEnabled boolean
Default value: `true`
Example:`true`
leadValueEnabled boolean
Default value: `true`
Example:`true`
marketingEnabled boolean
Default value: `true`
Example:`true`
agentReportingEnabled boolean
Default value: `true`
Example:`true`
botService boolean
Default value: `false`
Example:`false`
socialPlanner boolean
Default value: `true`
Example:`true`
bloggingEnabled boolean
Default value: `true`
Example:`true`
invoiceEnabled boolean
Default value: `true`
Example:`true`
affiliateManagerEnabled boolean
Default value: `true`
Example:`true`
contentAiEnabled boolean
Default value: `true`
Example:`true`
refundsEnabled boolean
Default value: `true`
Example:`true`
recordPaymentEnabled boolean
Default value: `true`
Example:`true`
cancelSubscriptionEnabled boolean
Default value: `true`
Example:`true`
paymentsEnabled boolean
Default value: `true`
Example:`true`
communitiesEnabled boolean
Default value: `true`
Example:`true`
exportPaymentsEnabled boolean
Default value: `true`
Example:`true`
scopes string
Possible values: [`campaigns.readonly`, `campaigns.write`, `calendars.readonly`, `calendars/events.write`, `calendars/groups.write`, `calendars.write`, `contacts.write`, `contacts/bulkActions.write`, `workflows.readonly`, `workflows.write`, `triggers.write`, `funnels.write`, `forms.write`, `surveys.write`, `quizzes.write`, `websites.write`, `medias.write`, `medias.readonly`, `opportunities.write`, `opportunities/leadValue.readonly`, `opportunities/bulkActions.write`, `reporting/phone.readonly`, `reporting/adwords.readonly`, `reporting/facebookAds.readonly`, `reporting/attributions.readonly`, `prospecting/auditReport.write`, `reporting/reports.readonly`, `reporting/agent.readonly`, `reporting/reports.write`, `reporting/stats.export`, `payments.write`, `payments/records.write`, `payments/orders.readonly`, `payments/orders.export`, `payments/orders.import`, `payments/orders.collectPayment`, `payments/subscriptions.readonly`, `payments/subscriptions.write`, `payments/subscriptions.update`, `payments/subscriptions.export`, `payments/subscriptions.pauseResumeCancel`, `payments/subscriptions.sharePaymentMethod`, `payments/transactions.readonly`, `payments/transactions.export`, `payments/transactions.import`, `payments/transactions.refund`, `payments/transactions.viewReceipts`, `payments/taxesSettings.readonly`, `payments/settings.readonly`, `payments/taxesSettings.updateInclusiveExclusive`, `payments/taxesSettings.manageRates`, `payments/taxesSettings.configureAutomatic`, `products.readonly`, `products.write`, `products.delete`, `products.duplicate`, `products.bulkActions`, `payments/settings.configureReceipt`, `payments/settings.configureSubscription`, `invoices.write`, `invoices.readonly`, `invoices/schedule.readonly`, `invoices/schedule.write`, `invoices/template.readonly`, `invoices/template.write`, `reputation/review.write`, `reputation/listing.write`, `reputation/reviewsAIAgents.write`, `reputation/gbp.write`, `conversations.write`, `conversations.readonly`, `conversations/message.readonly`, `conversations/message.write`, `contentAI.write`, `dashboard/stats.readonly`, `locations/tags.write`, `locations/tags.readonly`, `marketing.write`, `eliza.write`, `settings.write`, `socialplanner/post.write`, `socialplanner/account.readonly`, `socialplanner/account.write`, `socialplanner/category.readonly`, `socialplanner/category.write`, `socialplanner/csv.readonly`, `socialplanner/csv.write`, `socialplanner/group.write`, `socialplanner/hashtag.readonly`, `socialplanner/hashtag.write`, `socialplanner/oauth.readonly`, `socialplanner/oauth.write`, `socialplanner/post.readonly`, `socialplanner/recurring.readonly`, `socialplanner/recurring.write`, `socialplanner/review.readonly`, `socialplanner/review.write`, `socialplanner/rss.readonly`, `socialplanner/rss.write`, `socialplanner/search.readonly`, `socialplanner/setting.readonly`, `socialplanner/setting.write`, `socialplanner/stat.readonly`, `socialplanner/tag.readonly`, `socialplanner/tag.write`, `socialplanner/filters.readonly`, `socialplanner/medias.readonly`, `socialplanner/medias.write`, `socialplanner/watermarks.readonly`, `socialplanner/watermarks.write`, `socialplanner/metatag.readonly`, `socialplanner/facebook.readonly`, `socialplanner/linkedin.readonly`, `socialplanner/twitter.readonly`, `socialplanner/notification.readonly`, `socialplanner/notification.write`, `socialplanner/snapshot.readonly`, `socialplanner/snapshot.write`, `marketing/affiliate.write`, `blogs.write`, `membership.write`, `communities.write`, `gokollab.write`, `certificates.write`, `certificates.readonly`, `adPublishing.write`, `adPublishing.readonly`, `prospecting.write`, `prospecting.readonly`, `prospecting/reports.readonly`, `private-integration-location.readonly`, `private-integration-location.write`, `private-integration-company.readonly`, `private-integration-company.write`, `native-integrations.readonly`, `native-integrations.write`, `wordpress.write`, `wordpress.read`, `custom-menu-link.write`, `qrcodes.write`, `users/team-management.write`, `users/team-management.readonly`, `loginas.write`, `users-sso-login-management.write`, `users-sso-login-management.readonly`, `sso-config.write`, `snapshots/api.readonly`, `snapshots/api.create`, `snapshots/api.edit`, `snapshots/api.push`, `snapshots/api.refresh`, `snapshots/api.share`, `snapshots/api.delete`, `internaltools.location-transfer.write`, `internaltools.location-transfer.readonly`, `affiliateportal.write`, `affiliateportal.readonly`, `companies.write`, `internaltools.billing.write`, `internaltools.billing.readonly`, `internaltools.billing-common.readonly`, `internaltools.billing-common.write`, `voice-ai-agents.write`, `voice-ai-agents.readonly`, `voice-ai-common.readonly`, `voice-ai-common.write`, `voice-ai-agent-goals.readonly`, `voice-ai-agent-goals.write`, `voice-ai-dashboard.readonly`, `agency/launchpad.write`, `agency/launchpad.readonly`, `launchpad/location.write`, `launchpad/location.readonly`, `text-ai-agents.write`, `text-ai-agent-goals.readonly`, `text-ai-agent-goals.write`, `text-ai-agent-training.write`, `text-ai-agents-dashboard.readonly`]
roles object
type string
Example:`account`
role string
Example:`admin`
locationIds string[]
Example:`["ve9EPM428h8vShlRW1KT"]`
restrictSubAccount boolean
Example:`true`
deleted boolean
Example:`false`
lcPhone object
LC Phone Inbound Phone Numbers
Example:`{"locationId":"+1234556677"}`
platformLanguage string
Platform language preference for the user
Possible values: [`en_US`, `es`, `fr_CA`, `fr_FR`, `nl`, `de`, `pt_PT`, `pt_BR`, `it`, `sv`, `da`, `fi`, `no`]
Example:`en_US`
]
count number
Example:1231
{
"users": [\
{\
"id": "0IHuJvc2ofPAAA8GzTRi",\
"name": "John Deo",\
"firstName": "John",\
"lastName": "Deo",\
"email": "john@deo.com",\
"phone": "+1 808-868-8888",\
"extension": "",\
"permissions": {\
"campaignsEnabled": true,\
"campaignsReadOnly": false,\
"contactsEnabled": true,\
"workflowsEnabled": true,\
"workflowsReadOnly": true,\
"triggersEnabled": true,\
"funnelsEnabled": true,\
"websitesEnabled": false,\
"opportunitiesEnabled": true,\
"dashboardStatsEnabled": true,\
"bulkRequestsEnabled": true,\
"appointmentsEnabled": true,\
"reviewsEnabled": true,\
"onlineListingsEnabled": true,\
"phoneCallEnabled": true,\
"conversationsEnabled": true,\
"assignedDataOnly": false,\
"adwordsReportingEnabled": false,\
"membershipEnabled": false,\
"facebookAdsReportingEnabled": false,\
"attributionsReportingEnabled": false,\
"settingsEnabled": true,\
"tagsEnabled": true,\
"leadValueEnabled": true,\
"marketingEnabled": true,\
"agentReportingEnabled": true,\
"botService": false,\
"socialPlanner": true,\
"bloggingEnabled": true,\
"invoiceEnabled": true,\
"affiliateManagerEnabled": true,\
"contentAiEnabled": true,\
"refundsEnabled": true,\
"recordPaymentEnabled": true,\
"cancelSubscriptionEnabled": true,\
"paymentsEnabled": true,\
"communitiesEnabled": true,\
"exportPaymentsEnabled": true\
},\
"scopes": "campaigns.readonly",\
"roles": {\
"type": "account",\
"role": "admin",\
"locationIds": [\
"ve9EPM428h8vShlRW1KT"\
],\
"restrictSubAccount": true\
},\
"deleted": false,\
"lcPhone": {\
"locationId": "+1234556677"\
},\
"platformLanguage": "en_US"\
}\
],
"count": 1231
}Bad Request
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:400
message string
Example:Bad Request
{
"statusCode": 400,
"message": "Bad Request"
}Unauthorized
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}Unprocessable Entity
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:422
message string[]
Example:["Unprocessable Entity"]
error string
Example:Unprocessable Entity
{
"statusCode": 422,
"message": [\
"Unprocessable Entity"\
],
"error": "Unprocessable Entity"
}name: Authorizationtype: httpscopes: users.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
-
curl
-
nodejs
-
python
-
php
-
java
-
go
-
ruby
-
powershell
-
CURL
curl -L 'https://services.leadconnectorhq.com/users/search/filter-by-email' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"companyId": "5DP41231LkQsiKESj6rh",
"emails": "user1@example.com,user2@example.com",
"deleted": false,
"skip": "1",
"limit": "10",
"projection": "all"
}'Request Collapse all
Base URL
Edit
https://services.leadconnectorhq.com
Auth
Bearer Token
Parameters
Version — headerrequired
---2021-07-28
Body required
{
"companyId": "5DP41231LkQsiKESj6rh",
"emails": "user1@example.com,user2@example.com",
"deleted": false,
"skip": "1",
"limit": "10",
"projection": "all"
}Send API Request
ResponseClear
Click the Send API Request button above and see the response here!
Source: https://marketplace.gohighlevel.com/docs/ghl/users/get-user/index.html
GET https://services.leadconnectorhq.com/users/:userId
Get User
users.readonly
OAuth Access Token``Private Integration Token
Agency Token``Sub-Account Token
Request
Version stringrequired
Possible values: [2021-07-28]
API Version
userId stringrequired
User Id
Example: ve9EPM428h8vShlRW1KT
Responses
- 200
- 400
- 401
- 422
Successful response
-
application/json
-
Schema
-
Example (auto)
Schema
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
campaignsEnabled boolean
Default value: true
Example:true
campaignsReadOnly boolean
Default value: false
Example:false
contactsEnabled boolean
Default value: true
Example:true
workflowsEnabled boolean
Default value: true
Example:true
workflowsReadOnly boolean
Default value: false
Example:true
triggersEnabled boolean
Default value: true
Example:true
funnelsEnabled boolean
Default value: true
Example:true
websitesEnabled boolean
Default value: false
Example:false
opportunitiesEnabled boolean
Default value: true
Example:true
dashboardStatsEnabled boolean
Default value: true
Example:true
bulkRequestsEnabled boolean
Default value: true
Example:true
appointmentsEnabled boolean
Default value: true
Example:true
reviewsEnabled boolean
Default value: true
Example:true
onlineListingsEnabled boolean
Default value: true
Example:true
phoneCallEnabled boolean
Default value: true
Example:true
conversationsEnabled boolean
Default value: true
Example:true
assignedDataOnly boolean
Default value: false
Example:false
adwordsReportingEnabled boolean
Default value: false
Example:false
membershipEnabled boolean
Default value: false
Example:false
facebookAdsReportingEnabled boolean
Default value: false
Example:false
attributionsReportingEnabled boolean
Default value: false
Example:false
settingsEnabled boolean
Default value: true
Example:true
tagsEnabled boolean
Default value: true
Example:true
leadValueEnabled boolean
Default value: true
Example:true
marketingEnabled boolean
Default value: true
Example:true
agentReportingEnabled boolean
Default value: true
Example:true
botService boolean
Default value: false
Example:false
socialPlanner boolean
Default value: true
Example:true
bloggingEnabled boolean
Default value: true
Example:true
invoiceEnabled boolean
Default value: true
Example:true
affiliateManagerEnabled boolean
Default value: true
Example:true
contentAiEnabled boolean
Default value: true
Example:true
refundsEnabled boolean
Default value: true
Example:true
recordPaymentEnabled boolean
Default value: true
Example:true
cancelSubscriptionEnabled boolean
Default value: true
Example:true
paymentsEnabled boolean
Default value: true
Example:true
communitiesEnabled boolean
Default value: true
Example:true
exportPaymentsEnabled boolean
Default value: true
Example:true
scopes string
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
roles object
type string
Example:account
role string
Example:admin
locationIds string[]
Example:["ve9EPM428h8vShlRW1KT"]
restrictSubAccount boolean
Example:true
lcPhone object
LC Phone Inbound Phone Numbers
Example:{"locationId":"+1234556677"}
platformLanguage string
Platform language preference for the user
Possible values: [en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no]
Example:en_US
{
"id": "0IHuJvc2ofPAAA8GzTRi",
"name": "John Deo",
"firstName": "John",
"lastName": "Deo",
"email": "john@deo.com",
"phone": "+1 808-868-8888",
"extension": "",
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": "campaigns.readonly",
"roles": {
"type": "account",
"role": "admin",
"locationIds": [\
"ve9EPM428h8vShlRW1KT"\
],
"restrictSubAccount": true
},
"lcPhone": {
"locationId": "+1234556677"
},
"platformLanguage": "en_US"
}Bad Request
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:400
message string
Example:Bad Request
{
"statusCode": 400,
"message": "Bad Request"
}Unauthorized
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}Unprocessable Entity
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:422
message string[]
Example:["Unprocessable Entity"]
error string
Example:Unprocessable Entity
{
"statusCode": 422,
"message": [\
"Unprocessable Entity"\
],
"error": "Unprocessable Entity"
}name: Authorizationtype: httpscopes: users.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
-
curl
-
nodejs
-
python
-
php
-
java
-
go
-
ruby
-
powershell
-
CURL
curl -L 'https://services.leadconnectorhq.com/users/:userId' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'Request Collapse all
Base URL
Edit
https://services.leadconnectorhq.com
Auth
Security Scheme
Agency-AccessLocation-Access
Bearer Token
Parameters
userId — pathrequired
Version — headerrequired
---2021-07-28
Send API Request
ResponseClear
Click the Send API Request button above and see the response here!
Source: https://marketplace.gohighlevel.com/docs/ghl/users/get-user-by-location/index.html
GET https://services.leadconnectorhq.com/users/
Get User by Location
users.readonly
OAuth Access Token``Private Integration Token
Sub-Account Token
Request
Version stringrequired
Possible values: [2021-07-28]
API Version
locationId stringrequired
Example: s4BtzHFWmT28mbb85uPa
Responses
- 200
- 400
- 401
Successful response
-
application/json
-
Schema
-
Example (auto)
Schema
users object[]
Array [
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
campaignsEnabled boolean
Default value: true
Example:`true`
campaignsReadOnly boolean
Default value: `false`
Example:`false`
contactsEnabled boolean
Default value: `true`
Example:`true`
workflowsEnabled boolean
Default value: `true`
Example:`true`
workflowsReadOnly boolean
Default value: `false`
Example:`true`
triggersEnabled boolean
Default value: `true`
Example:`true`
funnelsEnabled boolean
Default value: `true`
Example:`true`
websitesEnabled boolean
Default value: `false`
Example:`false`
opportunitiesEnabled boolean
Default value: `true`
Example:`true`
dashboardStatsEnabled boolean
Default value: `true`
Example:`true`
bulkRequestsEnabled boolean
Default value: `true`
Example:`true`
appointmentsEnabled boolean
Default value: `true`
Example:`true`
reviewsEnabled boolean
Default value: `true`
Example:`true`
onlineListingsEnabled boolean
Default value: `true`
Example:`true`
phoneCallEnabled boolean
Default value: `true`
Example:`true`
conversationsEnabled boolean
Default value: `true`
Example:`true`
assignedDataOnly boolean
Default value: `false`
Example:`false`
adwordsReportingEnabled boolean
Default value: `false`
Example:`false`
membershipEnabled boolean
Default value: `false`
Example:`false`
facebookAdsReportingEnabled boolean
Default value: `false`
Example:`false`
attributionsReportingEnabled boolean
Default value: `false`
Example:`false`
settingsEnabled boolean
Default value: `true`
Example:`true`
tagsEnabled boolean
Default value: `true`
Example:`true`
leadValueEnabled boolean
Default value: `true`
Example:`true`
marketingEnabled boolean
Default value: `true`
Example:`true`
agentReportingEnabled boolean
Default value: `true`
Example:`true`
botService boolean
Default value: `false`
Example:`false`
socialPlanner boolean
Default value: `true`
Example:`true`
bloggingEnabled boolean
Default value: `true`
Example:`true`
invoiceEnabled boolean
Default value: `true`
Example:`true`
affiliateManagerEnabled boolean
Default value: `true`
Example:`true`
contentAiEnabled boolean
Default value: `true`
Example:`true`
refundsEnabled boolean
Default value: `true`
Example:`true`
recordPaymentEnabled boolean
Default value: `true`
Example:`true`
cancelSubscriptionEnabled boolean
Default value: `true`
Example:`true`
paymentsEnabled boolean
Default value: `true`
Example:`true`
communitiesEnabled boolean
Default value: `true`
Example:`true`
exportPaymentsEnabled boolean
Default value: `true`
Example:`true`
scopes string
Possible values: [`campaigns.readonly`, `campaigns.write`, `calendars.readonly`, `calendars/events.write`, `calendars/groups.write`, `calendars.write`, `contacts.write`, `contacts/bulkActions.write`, `workflows.readonly`, `workflows.write`, `triggers.write`, `funnels.write`, `forms.write`, `surveys.write`, `quizzes.write`, `websites.write`, `medias.write`, `medias.readonly`, `opportunities.write`, `opportunities/leadValue.readonly`, `opportunities/bulkActions.write`, `reporting/phone.readonly`, `reporting/adwords.readonly`, `reporting/facebookAds.readonly`, `reporting/attributions.readonly`, `prospecting/auditReport.write`, `reporting/reports.readonly`, `reporting/agent.readonly`, `reporting/reports.write`, `reporting/stats.export`, `payments.write`, `payments/records.write`, `payments/orders.readonly`, `payments/orders.export`, `payments/orders.import`, `payments/orders.collectPayment`, `payments/subscriptions.readonly`, `payments/subscriptions.write`, `payments/subscriptions.update`, `payments/subscriptions.export`, `payments/subscriptions.pauseResumeCancel`, `payments/subscriptions.sharePaymentMethod`, `payments/transactions.readonly`, `payments/transactions.export`, `payments/transactions.import`, `payments/transactions.refund`, `payments/transactions.viewReceipts`, `payments/taxesSettings.readonly`, `payments/settings.readonly`, `payments/taxesSettings.updateInclusiveExclusive`, `payments/taxesSettings.manageRates`, `payments/taxesSettings.configureAutomatic`, `products.readonly`, `products.write`, `products.delete`, `products.duplicate`, `products.bulkActions`, `payments/settings.configureReceipt`, `payments/settings.configureSubscription`, `invoices.write`, `invoices.readonly`, `invoices/schedule.readonly`, `invoices/schedule.write`, `invoices/template.readonly`, `invoices/template.write`, `reputation/review.write`, `reputation/listing.write`, `reputation/reviewsAIAgents.write`, `reputation/gbp.write`, `conversations.write`, `conversations.readonly`, `conversations/message.readonly`, `conversations/message.write`, `contentAI.write`, `dashboard/stats.readonly`, `locations/tags.write`, `locations/tags.readonly`, `marketing.write`, `eliza.write`, `settings.write`, `socialplanner/post.write`, `socialplanner/account.readonly`, `socialplanner/account.write`, `socialplanner/category.readonly`, `socialplanner/category.write`, `socialplanner/csv.readonly`, `socialplanner/csv.write`, `socialplanner/group.write`, `socialplanner/hashtag.readonly`, `socialplanner/hashtag.write`, `socialplanner/oauth.readonly`, `socialplanner/oauth.write`, `socialplanner/post.readonly`, `socialplanner/recurring.readonly`, `socialplanner/recurring.write`, `socialplanner/review.readonly`, `socialplanner/review.write`, `socialplanner/rss.readonly`, `socialplanner/rss.write`, `socialplanner/search.readonly`, `socialplanner/setting.readonly`, `socialplanner/setting.write`, `socialplanner/stat.readonly`, `socialplanner/tag.readonly`, `socialplanner/tag.write`, `socialplanner/filters.readonly`, `socialplanner/medias.readonly`, `socialplanner/medias.write`, `socialplanner/watermarks.readonly`, `socialplanner/watermarks.write`, `socialplanner/metatag.readonly`, `socialplanner/facebook.readonly`, `socialplanner/linkedin.readonly`, `socialplanner/twitter.readonly`, `socialplanner/notification.readonly`, `socialplanner/notification.write`, `socialplanner/snapshot.readonly`, `socialplanner/snapshot.write`, `marketing/affiliate.write`, `blogs.write`, `membership.write`, `communities.write`, `gokollab.write`, `certificates.write`, `certificates.readonly`, `adPublishing.write`, `adPublishing.readonly`, `prospecting.write`, `prospecting.readonly`, `prospecting/reports.readonly`, `private-integration-location.readonly`, `private-integration-location.write`, `private-integration-company.readonly`, `private-integration-company.write`, `native-integrations.readonly`, `native-integrations.write`, `wordpress.write`, `wordpress.read`, `custom-menu-link.write`, `qrcodes.write`, `users/team-management.write`, `users/team-management.readonly`, `loginas.write`, `users-sso-login-management.write`, `users-sso-login-management.readonly`, `sso-config.write`, `snapshots/api.readonly`, `snapshots/api.create`, `snapshots/api.edit`, `snapshots/api.push`, `snapshots/api.refresh`, `snapshots/api.share`, `snapshots/api.delete`, `internaltools.location-transfer.write`, `internaltools.location-transfer.readonly`, `affiliateportal.write`, `affiliateportal.readonly`, `companies.write`, `internaltools.billing.write`, `internaltools.billing.readonly`, `internaltools.billing-common.readonly`, `internaltools.billing-common.write`, `voice-ai-agents.write`, `voice-ai-agents.readonly`, `voice-ai-common.readonly`, `voice-ai-common.write`, `voice-ai-agent-goals.readonly`, `voice-ai-agent-goals.write`, `voice-ai-dashboard.readonly`, `agency/launchpad.write`, `agency/launchpad.readonly`, `launchpad/location.write`, `launchpad/location.readonly`, `text-ai-agents.write`, `text-ai-agent-goals.readonly`, `text-ai-agent-goals.write`, `text-ai-agent-training.write`, `text-ai-agents-dashboard.readonly`]
roles object
type string
Example:`account`
role string
Example:`admin`
locationIds string[]
Example:`["ve9EPM428h8vShlRW1KT"]`
restrictSubAccount boolean
Example:`true`
deleted boolean
Example:`false`
lcPhone object
LC Phone Inbound Phone Numbers
Example:`{"locationId":"+1234556677"}`
platformLanguage string
Platform language preference for the user
Possible values: [`en_US`, `es`, `fr_CA`, `fr_FR`, `nl`, `de`, `pt_PT`, `pt_BR`, `it`, `sv`, `da`, `fi`, `no`]
Example:`en_US`
]
{
"users": [\
{\
"id": "0IHuJvc2ofPAAA8GzTRi",\
"name": "John Deo",\
"firstName": "John",\
"lastName": "Deo",\
"email": "john@deo.com",\
"phone": "+1 808-868-8888",\
"extension": "",\
"permissions": {\
"campaignsEnabled": true,\
"campaignsReadOnly": false,\
"contactsEnabled": true,\
"workflowsEnabled": true,\
"workflowsReadOnly": true,\
"triggersEnabled": true,\
"funnelsEnabled": true,\
"websitesEnabled": false,\
"opportunitiesEnabled": true,\
"dashboardStatsEnabled": true,\
"bulkRequestsEnabled": true,\
"appointmentsEnabled": true,\
"reviewsEnabled": true,\
"onlineListingsEnabled": true,\
"phoneCallEnabled": true,\
"conversationsEnabled": true,\
"assignedDataOnly": false,\
"adwordsReportingEnabled": false,\
"membershipEnabled": false,\
"facebookAdsReportingEnabled": false,\
"attributionsReportingEnabled": false,\
"settingsEnabled": true,\
"tagsEnabled": true,\
"leadValueEnabled": true,\
"marketingEnabled": true,\
"agentReportingEnabled": true,\
"botService": false,\
"socialPlanner": true,\
"bloggingEnabled": true,\
"invoiceEnabled": true,\
"affiliateManagerEnabled": true,\
"contentAiEnabled": true,\
"refundsEnabled": true,\
"recordPaymentEnabled": true,\
"cancelSubscriptionEnabled": true,\
"paymentsEnabled": true,\
"communitiesEnabled": true,\
"exportPaymentsEnabled": true\
},\
"scopes": "campaigns.readonly",\
"roles": {\
"type": "account",\
"role": "admin",\
"locationIds": [\
"ve9EPM428h8vShlRW1KT"\
],\
"restrictSubAccount": true\
},\
"deleted": false,\
"lcPhone": {\
"locationId": "+1234556677"\
},\
"platformLanguage": "en_US"\
}\
]
}Bad Request
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:400
message string
Example:Bad Request
{
"statusCode": 400,
"message": "Bad Request"
}Unauthorized
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}name: Authorizationtype: httpscopes: users.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
-
curl
-
nodejs
-
python
-
php
-
java
-
go
-
ruby
-
powershell
-
CURL
curl -L 'https://services.leadconnectorhq.com/users/' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'Request Collapse all
Base URL
Edit
https://services.leadconnectorhq.com
Auth
Bearer Token
Parameters
locationId — queryrequired
Version — headerrequired
---2021-07-28
Send API Request
ResponseClear
Click the Send API Request button above and see the response here!
Source: https://marketplace.gohighlevel.com/docs/ghl/users/search/index.html
Documentation for users API
📄️ Search Users \ Search Users📄️ Filter Users by Email \ Filter users by company ID, deleted status, and email array
Source: https://marketplace.gohighlevel.com/docs/ghl/users/search-users/index.html
GET https://services.leadconnectorhq.com/users/search
Search Users
users.readonly
OAuth Access Token``Private Integration Token
Agency Token``Sub-Account Token
Request
Version stringrequired
Possible values: [2021-07-28]
API Version
companyId stringrequired
Company ID in which the search needs to be performed
Example: 5DP41231LkQsiKESj6rh
query string
The search term for the user is matched based on the user full name, email or phone
Example: John
skip string
No of results to be skipped before returning the result
Default value:0
Example: 1
limit string
No of results to be limited before returning the result
Default value:25
Example: 10
locationId string
Location ID in which the search needs to be performed
Example: 5DP41231LkQsiKESj6rh
type string
Type of the users to be filtered in the search
Example: agency
role string
Role of the users to be filtered in the search
Example: admin
ids string
List of User IDs to be filtered in the search
Example: 5DP4iH6HLkQsiKESj6rh,5DP4iH6HLkQsiKESj34h
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
Example: dateAdded
sortDirection string
The direction in which the results need to be sorted
Example: asc
enabled2waySync boolean
Responses
- 200
- 400
- 401
- 422
Successful response
-
application/json
-
Schema
-
Example (auto)
Schema
users object[]
Array [
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
campaignsEnabled boolean
Default value: true
Example:`true`
campaignsReadOnly boolean
Default value: `false`
Example:`false`
contactsEnabled boolean
Default value: `true`
Example:`true`
workflowsEnabled boolean
Default value: `true`
Example:`true`
workflowsReadOnly boolean
Default value: `false`
Example:`true`
triggersEnabled boolean
Default value: `true`
Example:`true`
funnelsEnabled boolean
Default value: `true`
Example:`true`
websitesEnabled boolean
Default value: `false`
Example:`false`
opportunitiesEnabled boolean
Default value: `true`
Example:`true`
dashboardStatsEnabled boolean
Default value: `true`
Example:`true`
bulkRequestsEnabled boolean
Default value: `true`
Example:`true`
appointmentsEnabled boolean
Default value: `true`
Example:`true`
reviewsEnabled boolean
Default value: `true`
Example:`true`
onlineListingsEnabled boolean
Default value: `true`
Example:`true`
phoneCallEnabled boolean
Default value: `true`
Example:`true`
conversationsEnabled boolean
Default value: `true`
Example:`true`
assignedDataOnly boolean
Default value: `false`
Example:`false`
adwordsReportingEnabled boolean
Default value: `false`
Example:`false`
membershipEnabled boolean
Default value: `false`
Example:`false`
facebookAdsReportingEnabled boolean
Default value: `false`
Example:`false`
attributionsReportingEnabled boolean
Default value: `false`
Example:`false`
settingsEnabled boolean
Default value: `true`
Example:`true`
tagsEnabled boolean
Default value: `true`
Example:`true`
leadValueEnabled boolean
Default value: `true`
Example:`true`
marketingEnabled boolean
Default value: `true`
Example:`true`
agentReportingEnabled boolean
Default value: `true`
Example:`true`
botService boolean
Default value: `false`
Example:`false`
socialPlanner boolean
Default value: `true`
Example:`true`
bloggingEnabled boolean
Default value: `true`
Example:`true`
invoiceEnabled boolean
Default value: `true`
Example:`true`
affiliateManagerEnabled boolean
Default value: `true`
Example:`true`
contentAiEnabled boolean
Default value: `true`
Example:`true`
refundsEnabled boolean
Default value: `true`
Example:`true`
recordPaymentEnabled boolean
Default value: `true`
Example:`true`
cancelSubscriptionEnabled boolean
Default value: `true`
Example:`true`
paymentsEnabled boolean
Default value: `true`
Example:`true`
communitiesEnabled boolean
Default value: `true`
Example:`true`
exportPaymentsEnabled boolean
Default value: `true`
Example:`true`
scopes string
Possible values: [`campaigns.readonly`, `campaigns.write`, `calendars.readonly`, `calendars/events.write`, `calendars/groups.write`, `calendars.write`, `contacts.write`, `contacts/bulkActions.write`, `workflows.readonly`, `workflows.write`, `triggers.write`, `funnels.write`, `forms.write`, `surveys.write`, `quizzes.write`, `websites.write`, `medias.write`, `medias.readonly`, `opportunities.write`, `opportunities/leadValue.readonly`, `opportunities/bulkActions.write`, `reporting/phone.readonly`, `reporting/adwords.readonly`, `reporting/facebookAds.readonly`, `reporting/attributions.readonly`, `prospecting/auditReport.write`, `reporting/reports.readonly`, `reporting/agent.readonly`, `reporting/reports.write`, `reporting/stats.export`, `payments.write`, `payments/records.write`, `payments/orders.readonly`, `payments/orders.export`, `payments/orders.import`, `payments/orders.collectPayment`, `payments/subscriptions.readonly`, `payments/subscriptions.write`, `payments/subscriptions.update`, `payments/subscriptions.export`, `payments/subscriptions.pauseResumeCancel`, `payments/subscriptions.sharePaymentMethod`, `payments/transactions.readonly`, `payments/transactions.export`, `payments/transactions.import`, `payments/transactions.refund`, `payments/transactions.viewReceipts`, `payments/taxesSettings.readonly`, `payments/settings.readonly`, `payments/taxesSettings.updateInclusiveExclusive`, `payments/taxesSettings.manageRates`, `payments/taxesSettings.configureAutomatic`, `products.readonly`, `products.write`, `products.delete`, `products.duplicate`, `products.bulkActions`, `payments/settings.configureReceipt`, `payments/settings.configureSubscription`, `invoices.write`, `invoices.readonly`, `invoices/schedule.readonly`, `invoices/schedule.write`, `invoices/template.readonly`, `invoices/template.write`, `reputation/review.write`, `reputation/listing.write`, `reputation/reviewsAIAgents.write`, `reputation/gbp.write`, `conversations.write`, `conversations.readonly`, `conversations/message.readonly`, `conversations/message.write`, `contentAI.write`, `dashboard/stats.readonly`, `locations/tags.write`, `locations/tags.readonly`, `marketing.write`, `eliza.write`, `settings.write`, `socialplanner/post.write`, `socialplanner/account.readonly`, `socialplanner/account.write`, `socialplanner/category.readonly`, `socialplanner/category.write`, `socialplanner/csv.readonly`, `socialplanner/csv.write`, `socialplanner/group.write`, `socialplanner/hashtag.readonly`, `socialplanner/hashtag.write`, `socialplanner/oauth.readonly`, `socialplanner/oauth.write`, `socialplanner/post.readonly`, `socialplanner/recurring.readonly`, `socialplanner/recurring.write`, `socialplanner/review.readonly`, `socialplanner/review.write`, `socialplanner/rss.readonly`, `socialplanner/rss.write`, `socialplanner/search.readonly`, `socialplanner/setting.readonly`, `socialplanner/setting.write`, `socialplanner/stat.readonly`, `socialplanner/tag.readonly`, `socialplanner/tag.write`, `socialplanner/filters.readonly`, `socialplanner/medias.readonly`, `socialplanner/medias.write`, `socialplanner/watermarks.readonly`, `socialplanner/watermarks.write`, `socialplanner/metatag.readonly`, `socialplanner/facebook.readonly`, `socialplanner/linkedin.readonly`, `socialplanner/twitter.readonly`, `socialplanner/notification.readonly`, `socialplanner/notification.write`, `socialplanner/snapshot.readonly`, `socialplanner/snapshot.write`, `marketing/affiliate.write`, `blogs.write`, `membership.write`, `communities.write`, `gokollab.write`, `certificates.write`, `certificates.readonly`, `adPublishing.write`, `adPublishing.readonly`, `prospecting.write`, `prospecting.readonly`, `prospecting/reports.readonly`, `private-integration-location.readonly`, `private-integration-location.write`, `private-integration-company.readonly`, `private-integration-company.write`, `native-integrations.readonly`, `native-integrations.write`, `wordpress.write`, `wordpress.read`, `custom-menu-link.write`, `qrcodes.write`, `users/team-management.write`, `users/team-management.readonly`, `loginas.write`, `users-sso-login-management.write`, `users-sso-login-management.readonly`, `sso-config.write`, `snapshots/api.readonly`, `snapshots/api.create`, `snapshots/api.edit`, `snapshots/api.push`, `snapshots/api.refresh`, `snapshots/api.share`, `snapshots/api.delete`, `internaltools.location-transfer.write`, `internaltools.location-transfer.readonly`, `affiliateportal.write`, `affiliateportal.readonly`, `companies.write`, `internaltools.billing.write`, `internaltools.billing.readonly`, `internaltools.billing-common.readonly`, `internaltools.billing-common.write`, `voice-ai-agents.write`, `voice-ai-agents.readonly`, `voice-ai-common.readonly`, `voice-ai-common.write`, `voice-ai-agent-goals.readonly`, `voice-ai-agent-goals.write`, `voice-ai-dashboard.readonly`, `agency/launchpad.write`, `agency/launchpad.readonly`, `launchpad/location.write`, `launchpad/location.readonly`, `text-ai-agents.write`, `text-ai-agent-goals.readonly`, `text-ai-agent-goals.write`, `text-ai-agent-training.write`, `text-ai-agents-dashboard.readonly`]
roles object
type string
Example:`account`
role string
Example:`admin`
locationIds string[]
Example:`["ve9EPM428h8vShlRW1KT"]`
restrictSubAccount boolean
Example:`true`
deleted boolean
Example:`false`
lcPhone object
LC Phone Inbound Phone Numbers
Example:`{"locationId":"+1234556677"}`
platformLanguage string
Platform language preference for the user
Possible values: [`en_US`, `es`, `fr_CA`, `fr_FR`, `nl`, `de`, `pt_PT`, `pt_BR`, `it`, `sv`, `da`, `fi`, `no`]
Example:`en_US`
]
count number
Example:1231
{
"users": [\
{\
"id": "0IHuJvc2ofPAAA8GzTRi",\
"name": "John Deo",\
"firstName": "John",\
"lastName": "Deo",\
"email": "john@deo.com",\
"phone": "+1 808-868-8888",\
"extension": "",\
"permissions": {\
"campaignsEnabled": true,\
"campaignsReadOnly": false,\
"contactsEnabled": true,\
"workflowsEnabled": true,\
"workflowsReadOnly": true,\
"triggersEnabled": true,\
"funnelsEnabled": true,\
"websitesEnabled": false,\
"opportunitiesEnabled": true,\
"dashboardStatsEnabled": true,\
"bulkRequestsEnabled": true,\
"appointmentsEnabled": true,\
"reviewsEnabled": true,\
"onlineListingsEnabled": true,\
"phoneCallEnabled": true,\
"conversationsEnabled": true,\
"assignedDataOnly": false,\
"adwordsReportingEnabled": false,\
"membershipEnabled": false,\
"facebookAdsReportingEnabled": false,\
"attributionsReportingEnabled": false,\
"settingsEnabled": true,\
"tagsEnabled": true,\
"leadValueEnabled": true,\
"marketingEnabled": true,\
"agentReportingEnabled": true,\
"botService": false,\
"socialPlanner": true,\
"bloggingEnabled": true,\
"invoiceEnabled": true,\
"affiliateManagerEnabled": true,\
"contentAiEnabled": true,\
"refundsEnabled": true,\
"recordPaymentEnabled": true,\
"cancelSubscriptionEnabled": true,\
"paymentsEnabled": true,\
"communitiesEnabled": true,\
"exportPaymentsEnabled": true\
},\
"scopes": "campaigns.readonly",\
"roles": {\
"type": "account",\
"role": "admin",\
"locationIds": [\
"ve9EPM428h8vShlRW1KT"\
],\
"restrictSubAccount": true\
},\
"deleted": false,\
"lcPhone": {\
"locationId": "+1234556677"\
},\
"platformLanguage": "en_US"\
}\
],
"count": 1231
}Bad Request
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:400
message string
Example:Bad Request
{
"statusCode": 400,
"message": "Bad Request"
}Unauthorized
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}Unprocessable Entity
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:422
message string[]
Example:["Unprocessable Entity"]
error string
Example:Unprocessable Entity
{
"statusCode": 422,
"message": [\
"Unprocessable Entity"\
],
"error": "Unprocessable Entity"
}name: Authorizationtype: httpscopes: users.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
-
curl
-
nodejs
-
python
-
php
-
java
-
go
-
ruby
-
powershell
-
CURL
curl -L 'https://services.leadconnectorhq.com/users/search' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'Request Collapse all
Base URL
Edit
https://services.leadconnectorhq.com
Auth
Security Scheme
Agency-AccessLocation-Access
Bearer Token
Parameters
companyId — queryrequired
Version — headerrequired
---2021-07-28
Show optional parameters
query — query
skip — query
limit — query
locationId — query
type — query
role — query
ids — query
sort — query
sortDirection — query
enabled2waySync — query
---truefalse
Send API Request
ResponseClear
Click the Send API Request button above and see the response here!
Source: https://marketplace.gohighlevel.com/docs/ghl/users/update-user/index.html
PUT https://services.leadconnectorhq.com/users/:userId
Update User
users.write
OAuth Access Token``Private Integration Token
Agency Token``Sub-Account Token
Request
Version stringrequired
Possible values: [2021-07-28]
API Version
- application/json
firstName string
Example:John
lastName string
Example:Deo
email stringdeprecated
Email update is no longer supported due to security reasons.
Example:john@deo.com
password string
Example:*******
phone string
Example:+18832327657
type string
Example:account
role string
Example:admin
companyId string
Company/Agency Id. Required for Agency Level access
Example:UAXssdawIWAWD
locationIds string[]
Example:["C2QujeCh8ZnC7al2InWR"]
permissions object
campaignsEnabled boolean
Default value: true
Example:true
campaignsReadOnly boolean
Default value: false
Example:false
contactsEnabled boolean
Default value: true
Example:true
workflowsEnabled boolean
Default value: true
Example:true
workflowsReadOnly boolean
Default value: false
Example:true
triggersEnabled boolean
Default value: true
Example:true
funnelsEnabled boolean
Default value: true
Example:true
websitesEnabled boolean
Default value: false
Example:false
opportunitiesEnabled boolean
Default value: true
Example:true
dashboardStatsEnabled boolean
Default value: true
Example:true
bulkRequestsEnabled boolean
Default value: true
Example:true
appointmentsEnabled boolean
Default value: true
Example:true
reviewsEnabled boolean
Default value: true
Example:true
onlineListingsEnabled boolean
Default value: true
Example:true
phoneCallEnabled boolean
Default value: true
Example:true
conversationsEnabled boolean
Default value: true
Example:true
assignedDataOnly boolean
Default value: false
Example:false
adwordsReportingEnabled boolean
Default value: false
Example:false
membershipEnabled boolean
Default value: false
Example:false
facebookAdsReportingEnabled boolean
Default value: false
Example:false
attributionsReportingEnabled boolean
Default value: false
Example:false
settingsEnabled boolean
Default value: true
Example:true
tagsEnabled boolean
Default value: true
Example:true
leadValueEnabled boolean
Default value: true
Example:true
marketingEnabled boolean
Default value: true
Example:true
agentReportingEnabled boolean
Default value: true
Example:true
botService boolean
Default value: false
Example:false
socialPlanner boolean
Default value: true
Example:true
bloggingEnabled boolean
Default value: true
Example:true
invoiceEnabled boolean
Default value: true
Example:true
affiliateManagerEnabled boolean
Default value: true
Example:true
contentAiEnabled boolean
Default value: true
Example:true
refundsEnabled boolean
Default value: true
Example:true
recordPaymentEnabled boolean
Default value: true
Example:true
cancelSubscriptionEnabled boolean
Default value: true
Example:true
paymentsEnabled boolean
Default value: true
Example:true
communitiesEnabled boolean
Default value: true
Example:true
exportPaymentsEnabled boolean
Default value: true
Example:true
scopes string[]
Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the scopes will be get disabled
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
Example:["contacts.write","campaigns.readonly"]
scopesAssignedToOnly string[]
Assigned Scopes allowed for users. Only scopes that have been passed will be enabled. If passed empty all the assigned scopes will be get disabled
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
Example:["contacts.write","campaigns.readonly"]
profilePhoto string
Example:https://img.png
platformLanguage string
Platform language preference for the user
Possible values: [en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no]
Example:en_US
Responses
- 200
- 400
- 401
- 422
Successful response
-
application/json
-
Schema
-
Example (auto)
Schema
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
campaignsEnabled boolean
Default value: true
Example:true
campaignsReadOnly boolean
Default value: false
Example:false
contactsEnabled boolean
Default value: true
Example:true
workflowsEnabled boolean
Default value: true
Example:true
workflowsReadOnly boolean
Default value: false
Example:true
triggersEnabled boolean
Default value: true
Example:true
funnelsEnabled boolean
Default value: true
Example:true
websitesEnabled boolean
Default value: false
Example:false
opportunitiesEnabled boolean
Default value: true
Example:true
dashboardStatsEnabled boolean
Default value: true
Example:true
bulkRequestsEnabled boolean
Default value: true
Example:true
appointmentsEnabled boolean
Default value: true
Example:true
reviewsEnabled boolean
Default value: true
Example:true
onlineListingsEnabled boolean
Default value: true
Example:true
phoneCallEnabled boolean
Default value: true
Example:true
conversationsEnabled boolean
Default value: true
Example:true
assignedDataOnly boolean
Default value: false
Example:false
adwordsReportingEnabled boolean
Default value: false
Example:false
membershipEnabled boolean
Default value: false
Example:false
facebookAdsReportingEnabled boolean
Default value: false
Example:false
attributionsReportingEnabled boolean
Default value: false
Example:false
settingsEnabled boolean
Default value: true
Example:true
tagsEnabled boolean
Default value: true
Example:true
leadValueEnabled boolean
Default value: true
Example:true
marketingEnabled boolean
Default value: true
Example:true
agentReportingEnabled boolean
Default value: true
Example:true
botService boolean
Default value: false
Example:false
socialPlanner boolean
Default value: true
Example:true
bloggingEnabled boolean
Default value: true
Example:true
invoiceEnabled boolean
Default value: true
Example:true
affiliateManagerEnabled boolean
Default value: true
Example:true
contentAiEnabled boolean
Default value: true
Example:true
refundsEnabled boolean
Default value: true
Example:true
recordPaymentEnabled boolean
Default value: true
Example:true
cancelSubscriptionEnabled boolean
Default value: true
Example:true
paymentsEnabled boolean
Default value: true
Example:true
communitiesEnabled boolean
Default value: true
Example:true
exportPaymentsEnabled boolean
Default value: true
Example:true
scopes string
Possible values: [campaigns.readonly, campaigns.write, calendars.readonly, calendars/events.write, calendars/groups.write, calendars.write, contacts.write, contacts/bulkActions.write, workflows.readonly, workflows.write, triggers.write, funnels.write, forms.write, surveys.write, quizzes.write, websites.write, medias.write, medias.readonly, opportunities.write, opportunities/leadValue.readonly, opportunities/bulkActions.write, reporting/phone.readonly, reporting/adwords.readonly, reporting/facebookAds.readonly, reporting/attributions.readonly, prospecting/auditReport.write, reporting/reports.readonly, reporting/agent.readonly, reporting/reports.write, reporting/stats.export, payments.write, payments/records.write, payments/orders.readonly, payments/orders.export, payments/orders.import, payments/orders.collectPayment, payments/subscriptions.readonly, payments/subscriptions.write, payments/subscriptions.update, payments/subscriptions.export, payments/subscriptions.pauseResumeCancel, payments/subscriptions.sharePaymentMethod, payments/transactions.readonly, payments/transactions.export, payments/transactions.import, payments/transactions.refund, payments/transactions.viewReceipts, payments/taxesSettings.readonly, payments/settings.readonly, payments/taxesSettings.updateInclusiveExclusive, payments/taxesSettings.manageRates, payments/taxesSettings.configureAutomatic, products.readonly, products.write, products.delete, products.duplicate, products.bulkActions, payments/settings.configureReceipt, payments/settings.configureSubscription, invoices.write, invoices.readonly, invoices/schedule.readonly, invoices/schedule.write, invoices/template.readonly, invoices/template.write, reputation/review.write, reputation/listing.write, reputation/reviewsAIAgents.write, reputation/gbp.write, conversations.write, conversations.readonly, conversations/message.readonly, conversations/message.write, contentAI.write, dashboard/stats.readonly, locations/tags.write, locations/tags.readonly, marketing.write, eliza.write, settings.write, socialplanner/post.write, socialplanner/account.readonly, socialplanner/account.write, socialplanner/category.readonly, socialplanner/category.write, socialplanner/csv.readonly, socialplanner/csv.write, socialplanner/group.write, socialplanner/hashtag.readonly, socialplanner/hashtag.write, socialplanner/oauth.readonly, socialplanner/oauth.write, socialplanner/post.readonly, socialplanner/recurring.readonly, socialplanner/recurring.write, socialplanner/review.readonly, socialplanner/review.write, socialplanner/rss.readonly, socialplanner/rss.write, socialplanner/search.readonly, socialplanner/setting.readonly, socialplanner/setting.write, socialplanner/stat.readonly, socialplanner/tag.readonly, socialplanner/tag.write, socialplanner/filters.readonly, socialplanner/medias.readonly, socialplanner/medias.write, socialplanner/watermarks.readonly, socialplanner/watermarks.write, socialplanner/metatag.readonly, socialplanner/facebook.readonly, socialplanner/linkedin.readonly, socialplanner/twitter.readonly, socialplanner/notification.readonly, socialplanner/notification.write, socialplanner/snapshot.readonly, socialplanner/snapshot.write, marketing/affiliate.write, blogs.write, membership.write, communities.write, gokollab.write, certificates.write, certificates.readonly, adPublishing.write, adPublishing.readonly, prospecting.write, prospecting.readonly, prospecting/reports.readonly, private-integration-location.readonly, private-integration-location.write, private-integration-company.readonly, private-integration-company.write, native-integrations.readonly, native-integrations.write, wordpress.write, wordpress.read, custom-menu-link.write, qrcodes.write, users/team-management.write, users/team-management.readonly, loginas.write, users-sso-login-management.write, users-sso-login-management.readonly, sso-config.write, snapshots/api.readonly, snapshots/api.create, snapshots/api.edit, snapshots/api.push, snapshots/api.refresh, snapshots/api.share, snapshots/api.delete, internaltools.location-transfer.write, internaltools.location-transfer.readonly, affiliateportal.write, affiliateportal.readonly, companies.write, internaltools.billing.write, internaltools.billing.readonly, internaltools.billing-common.readonly, internaltools.billing-common.write, voice-ai-agents.write, voice-ai-agents.readonly, voice-ai-common.readonly, voice-ai-common.write, voice-ai-agent-goals.readonly, voice-ai-agent-goals.write, voice-ai-dashboard.readonly, agency/launchpad.write, agency/launchpad.readonly, launchpad/location.write, launchpad/location.readonly, text-ai-agents.write, text-ai-agent-goals.readonly, text-ai-agent-goals.write, text-ai-agent-training.write, text-ai-agents-dashboard.readonly]
roles object
type string
Example:account
role string
Example:admin
locationIds string[]
Example:["ve9EPM428h8vShlRW1KT"]
restrictSubAccount boolean
Example:true
lcPhone object
LC Phone Inbound Phone Numbers
Example:{"locationId":"+1234556677"}
platformLanguage string
Platform language preference for the user
Possible values: [en_US, es, fr_CA, fr_FR, nl, de, pt_PT, pt_BR, it, sv, da, fi, no]
Example:en_US
{
"id": "0IHuJvc2ofPAAA8GzTRi",
"name": "John Deo",
"firstName": "John",
"lastName": "Deo",
"email": "john@deo.com",
"phone": "+1 808-868-8888",
"extension": "",
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": "campaigns.readonly",
"roles": {
"type": "account",
"role": "admin",
"locationIds": [\
"ve9EPM428h8vShlRW1KT"\
],
"restrictSubAccount": true
},
"lcPhone": {
"locationId": "+1234556677"
},
"platformLanguage": "en_US"
}Bad Request
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:400
message string
Example:Bad Request
{
"statusCode": 400,
"message": "Bad Request"
}Unauthorized
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:401
message string
Example:Invalid token: access token is invalid
error string
Example:Unauthorized
{
"statusCode": 401,
"message": "Invalid token: access token is invalid",
"error": "Unauthorized"
}Unprocessable Entity
-
application/json
-
Schema
-
Example (auto)
Schema
statusCode number
Example:422
message string[]
Example:["Unprocessable Entity"]
error string
Example:Unprocessable Entity
{
"statusCode": 422,
"message": [\
"Unprocessable Entity"\
],
"error": "Unprocessable Entity"
}name: Authorizationtype: httpscopes: users.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
-
curl
-
nodejs
-
python
-
php
-
java
-
go
-
ruby
-
powershell
-
CURL
curl -L -X PUT 'https://services.leadconnectorhq.com/users/:userId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"firstName": "John",
"lastName": "Deo",
"password": "*******",
"phone": "+18832327657",
"type": "account",
"role": "admin",
"companyId": "UAXssdawIWAWD",
"locationIds": [\
"C2QujeCh8ZnC7al2InWR"\
],
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": [\
"contacts.write",\
"campaigns.readonly"\
],
"scopesAssignedToOnly": [\
"contacts.write",\
"campaigns.readonly"\
],
"profilePhoto": "https://img.png",
"platformLanguage": "en_US"
}'Request Collapse all
Base URL
Edit
https://services.leadconnectorhq.com
Auth
Security Scheme
Agency-AccessLocation-Access
Bearer Token
Parameters
Version — headerrequired
---2021-07-28
Body required
{
"firstName": "John",
"lastName": "Deo",
"password": "*******",
"phone": "+18832327657",
"type": "account",
"role": "admin",
"companyId": "UAXssdawIWAWD",
"locationIds": [\
"C2QujeCh8ZnC7al2InWR"\
],
"permissions": {
"campaignsEnabled": true,
"campaignsReadOnly": false,
"contactsEnabled": true,
"workflowsEnabled": true,
"workflowsReadOnly": true,
"triggersEnabled": true,
"funnelsEnabled": true,
"websitesEnabled": false,
"opportunitiesEnabled": true,
"dashboardStatsEnabled": true,
"bulkRequestsEnabled": true,
"appointmentsEnabled": true,
"reviewsEnabled": true,
"onlineListingsEnabled": true,
"phoneCallEnabled": true,
"conversationsEnabled": true,
"assignedDataOnly": false,
"adwordsReportingEnabled": false,
"membershipEnabled": false,
"facebookAdsReportingEnabled": false,
"attributionsReportingEnabled": false,
"settingsEnabled": true,
"tagsEnabled": true,
"leadValueEnabled": true,
"marketingEnabled": true,
"agentReportingEnabled": true,
"botService": false,
"socialPlanner": true,
"bloggingEnabled": true,
"invoiceEnabled": true,
"affiliateManagerEnabled": true,
"contentAiEnabled": true,
"refundsEnabled": true,
"recordPaymentEnabled": true,
"cancelSubscriptionEnabled": true,
"paymentsEnabled": true,
"communitiesEnabled": true,
"exportPaymentsEnabled": true
},
"scopes": [\
"contacts.write",\
"campaigns.readonly"\
],
"scopesAssignedToOnly": [\
"contacts.write",\
"campaigns.readonly"\
],
"profilePhoto": "https://img.png",
"platformLanguage": "en_US"
}Send API Request
ResponseClear
Click the Send API Request button above and see the response here!