Skip to main content
Search Users 
GET https://services.leadconnectorhq.com/users/search

​
Autorización

​
Authorization
string
required
Bearer token generado desde el portal Leadway. Ver Autenticación.
​
Version
string
default:"2021-07-28"
required
Versión 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

​
users
object[]
​
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
}

{}

{}

{}

​
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);