Skip to main content
Retrieve the list of affiliates for a account. 
GET https://services.leadconnectorhq.com/affiliate-manager/{locationId}/affiliates

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

​
Path parameters

​
locationId
string
default:"ve9EPM428h8vShlRW1KT"
required
Account Id

​
Query parameters

​
query
string
default:"John"
​
active
string
default:"True"
​
campaignId
string
default:"63d376de11be1d26d38f7369"
​
skip
number
default:"1"
​
limit
number
default:"10"
Maximum number of records to return. Maximum allowed value is 100.
​
fromDate
string
default:"2023-10-01"
​
toDate
string
default:"2023-10-01"

​
Respuestas

​
affiliates
object[]
required
Affiliate list
​
meta
object
required
Pagination metadata
{
  "affiliates": [
    {
      "_id": "63d147176c5bbc30e9e091a4",
      "firstName": "John",
      "lastName": "Doe",
      "phone": "+1 888 888-8888",
      "deleted": false,
      "locationId": "ve9EPM428h8vShlRW1KT",
      "active": true,
      "address": "123 Main St",
      "avatar": "https://example.com/avatar.png",
      "createdAt": "2024-06-16T00:00:00.000Z",
      "createdBy": {},
      "facebookUrl": "https://facebook.com/johndoe",
      "instagramUrl": "https://instagram.com/johndoe",
      "linkedInUrl": "https://linkedin.com/in/johndoe",
      "twitterUrl": "https://twitter.com/johndoe",
      "youtubeUrl": "https://youtube.com/channel",
      "websiteUrl": "https://example.com",
      "contactId": "ve9EPM428h8vShlRW1KT",
      "campaignIds": [
        "650173614761b33c46d33b19"
      ],
      "vatId": "VAT123",
      "updatedAt": "2024-06-16T00:00:00.000Z",
      "w8Form": "string",
      "w9Form": "string",
      "lastUpdatedBy": {},
      "email": "john.doe@example.com",
      "revenue": 1250.5,
      "customer": 15,
      "lead": 5,
      "droppedCustomer": 2,
      "clickCount": 100,
      "paid": 500,
      "currency": "USD",
      "owned": 750
    }
  // truncado: 2 lineas mas
}

{}

{}

{}

​
Ejemplo

curl -X GET 'https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/affiliates' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28'

const response = await fetch('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/affiliates', {
  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/affiliate-manager/YOUR_locationId/affiliates',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
    },
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/affiliate-manager/YOUR_locationId/affiliates');
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);