Skip to main content
Filter users by company ID, deleted status, and email array 
POST https://services.leadconnectorhq.com/users/search/filter-by-email

​
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.

​
Body

​
companyId
string
default:"5DP41231LkQsiKESj6rh"
required
Company ID to filter users
​
emails
string
default:"user1@example.com,user2@example.com"
required
Comma-separated list of email addresses to filter users
​
deleted
boolean
default:"False"
Filter deleted users
​
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
​
projection
string
default:"all"
Projection fields to return. Use “all” for all fields, or specify comma-separated field names. Default returns only id and email

​
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 POST 'https://services.leadconnectorhq.com/users/search/filter-by-email' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "companyId": "5DP41231LkQsiKESj6rh",
  "emails": "user1@example.com,user2@example.com",
  "deleted": false,
  "skip": "1",
  "limit": "10",
  "projection": "all"
}'

const response = await fetch('https://services.leadconnectorhq.com/users/search/filter-by-email', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"companyId": "5DP41231LkQsiKESj6rh", "emails": "user1@example.com,user2@example.com", "deleted": false, "skip": "1", "limit": "10", "projection": "all"}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/users/search/filter-by-email',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"companyId": "5DP41231LkQsiKESj6rh", "emails": "user1@example.com,user2@example.com", "deleted": false, "skip": "1", "limit": "10", "projection": "all"},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/users/search/filter-by-email');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'companyId': '5DP41231LkQsiKESj6rh', 'emails': 'user1@example.com,user2@example.com', 'deleted': false, 'skip': '1', 'limit': '10', 'projection': 'all'}),
]);
$data = json_decode(curl_exec($ch), true);