Search Users

GET https://services.leadconnectorhq.com/users/search

Autorizacion

Authorization

string

required

Bearer token generado desde el portal Leadway. Ver Autenticacion.

Version

string

default:"2021-07-28"

required

Version de la API.

Query parameters

companyId

string

default:"5DP41231LkQsiKESj6rh"

required

Company ID in which the search needs to be performed

query

string

default:"John"

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

skip

string

default:"1"

No of results to be skipped before returning the result

limit

string

default:"10"

No of results to be limited before returning the result

locationId

string

default:"5DP41231LkQsiKESj6rh"

Account ID in which the search needs to be performed

type

string

default:"agency"

Type of the users to be filtered in the search

role

string

default:"admin"

Role of the users to be filtered in the search

ids

string

default:"5DP4iH6HLkQsiKESj6rh,5DP4iH6HLkQsiKESj34h"

List of User IDs to be filtered in the search

sort

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

sortDirection

string

default:"asc"

The direction in which the results need to be sorted

enabled2waySync

boolean

Respuestas

200 - Successful response

users

object[]

Show cada item

string

default:"0IHuJvc2ofPAAA8GzTRi"

name

string

default:"John Deo"

firstName

string

default:"John"

lastName

string

default:"Deo"

string

default:"john@deo.com"

phone

string

default:"+1 808-868-8888"

extension

string

default:""

permissions

object

Show propiedades

campaignsEnabled

boolean

default:"True"

campaignsReadOnly

boolean

default:"False"

contactsEnabled

boolean

default:"True"

workflowsEnabled

boolean

default:"True"

workflowsReadOnly

boolean

default:"True"

triggersEnabled

boolean

default:"True"

funnelsEnabled

boolean

default:"True"

websitesEnabled

boolean

default:"False"

opportunitiesEnabled

boolean

default:"True"

dashboardStatsEnabled

boolean

default:"True"

bulkRequestsEnabled

boolean

default:"True"

appointmentsEnabled

boolean

default:"True"

reviewsEnabled

boolean

default:"True"

onlineListingsEnabled

boolean

default:"True"

phoneCallEnabled

boolean

default:"True"

conversationsEnabled

boolean

default:"True"

assignedDataOnly

boolean

default:"False"

adwordsReportingEnabled

boolean

default:"False"

membershipEnabled

boolean

default:"False"

facebookAdsReportingEnabled

boolean

default:"False"

attributionsReportingEnabled

boolean

default:"False"

settingsEnabled

boolean

default:"True"

tagsEnabled

boolean

default:"True"

leadValueEnabled

boolean

default:"True"

marketingEnabled

boolean

default:"True"

agentReportingEnabled

boolean

default:"True"

botService

boolean

default:"False"

bloggingEnabled

boolean

default:"True"

invoiceEnabled

boolean

default:"True"

affiliateManagerEnabled

boolean

default:"True"

contentAiEnabled

boolean

default:"True"

refundsEnabled

boolean

default:"True"

recordPaymentEnabled

boolean

default:"True"

cancelSubscriptionEnabled

boolean

default:"True"

paymentsEnabled

boolean

default:"True"

communitiesEnabled

boolean

default:"True"

exportPaymentsEnabled

boolean

default:"True"

scopes

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’

roles

object

Show propiedades

type

string

default:"account"

role

string

default:"admin"

locationIds

string[]

restrictSubAccount

boolean

default:"True"

deleted

boolean

default:"False"

lcPhone

object

LC Phone Inbound Phone Numbers

platformLanguage

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’

count

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

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/users/search' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

Empezar

Scopes

Search Users

Autorizacion

Query parameters

Respuestas

Ejemplo

Empezar

Scopes

Documentation Index

​Autorizacion

​Query parameters

​Respuestas

​Ejemplo

Autorizacion

Query parameters

Respuestas

Ejemplo