GET https://services.leadconnectorhq.com/users/search
Autorización
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
string
default:"2021-07-28"
required
Versión de la API.
Query parameters
string
default:"5DP41231LkQsiKESj6rh"
required
Company ID in which the search needs to be performed
string
default:"John"
The search term for the user is matched based on the user full name, email or phone
string
default:"1"
No of results to be skipped before returning the result
string
default:"10"
No of results to be limited before returning the result
string
default:"5DP41231LkQsiKESj6rh"
Account ID in which the search needs to be performed
string
default:"agency"
Type of the users to be filtered in the search
string
default:"admin"
Role of the users to be filtered in the search
string
default:"5DP4iH6HLkQsiKESj6rh,5DP4iH6HLkQsiKESj34h"
List of User IDs to be filtered in the search
string
default:"dateAdded"
The field on which sort is applied in which the results need to be sorted. Default is based on the first and last name
string
default:"asc"
The direction in which the results need to be sorted
boolean
Respuestas
200 - Successful response
200 - Successful response
object[]
Show cada item
Show cada item
string
default:"0IHuJvc2ofPAAA8GzTRi"
string
default:"John Deo"
string
default:"John"
string
default:"Deo"
string
default:"john@deo.com"
string
default:"+1 808-868-8888"
string
default:""
object
Show propiedades
Show propiedades
boolean
default:"True"
boolean
default:"False"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"False"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"False"
boolean
default:"False"
boolean
default:"False"
boolean
default:"False"
boolean
default:"False"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"False"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
boolean
default:"True"
string
Posibles valores: ‘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.write’, ‘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-account.readonly’, ‘private-integration-account.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.account-transfer.write’, ‘internaltools.account-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/account.write’, ‘launchpad/account.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’, ‘accounts.create’, ‘accounts.delete’, ‘accounts.export.list’, ‘accounts.features-limits.manage’, ‘accounts.pause-resume’, ‘accounts.agency-accounts.manage’, ‘accounts.billing.manage’, ‘accounts.details.manage’, ‘audit-logs.readonly’, ‘audit-logs.export’
object
boolean
default:"False"
object
LC Phone Inbound Phone Numbers
string
default:"en_US"
Platform language preference for the user Posibles valores: ‘en_US’, ‘es’, ‘fr_CA’, ‘fr_FR’, ‘nl’, ‘de’, ‘pt_PT’, ‘pt_BR’, ‘it’, ‘sv’, ‘da’, ‘fi’, ‘no’
number
default:"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,
// truncado: 29 lineas mas
}
400 - Bad Request
400 - Bad Request
{}
401 - Unauthorized
401 - Unauthorized
{}
422 - Unprocessable Entity
422 - Unprocessable Entity
{}
Ejemplo
curl -X GET 'https://services.leadconnectorhq.com/users/search' \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Version: 2021-07-28'
const response = await fetch('https://services.leadconnectorhq.com/users/search', {
method: 'GET',
headers: {
Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
Version: '2021-07-28',
},
});
const data = await response.json();
import os, requests
response = requests.request(
'GET',
'https://services.leadconnectorhq.com/users/search',
headers={
'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
'Version': '2021-07-28',
},
)
data = response.json()
<?php
$ch = curl_init('https://services.leadconnectorhq.com/users/search');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
'Version: 2021-07-28',
],
]);
$data = json_decode(curl_exec($ch), true);