List Affiliate Users - Everflow API

List Affiliate Users

curl --request GET \
  --url https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users \
  --header 'X-Eflow-Api-Key: <api-key>'

import requests

url = "https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users"

headers = {"X-Eflow-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Eflow-Api-Key': '<api-key>'}};

fetch('https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Eflow-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Eflow-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "users": [
    {
      "network_affiliate_user_id": 17,
      "network_id": 1,
      "network_affiliate_id": 1,
      "first_name": "Bob",
      "last_name": "Smith",
      "email": "my.everflow@gmail.com",
      "title": "",
      "work_phone": "9655433513",
      "cell_phone": "",
      "instant_messaging_id": 0,
      "instant_messaging_identifier": "",
      "language_id": 1,
      "timezone_id": 75,
      "currency_id": "USD",
      "account_status": "active",
      "relationship": {
        "affiliate_account_status": "active"
      }
    }
  ]
}

GET

/

networks

/

affiliates

/

{affiliateId}

/

users

List Affiliate Users

curl --request GET \
  --url https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users \
  --header 'X-Eflow-Api-Key: <api-key>'

import requests

url = "https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users"

headers = {"X-Eflow-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Eflow-Api-Key': '<api-key>'}};

fetch('https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Eflow-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Eflow-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/affiliates/{affiliateId}/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "users": [
    {
      "network_affiliate_user_id": 17,
      "network_id": 1,
      "network_affiliate_id": 1,
      "first_name": "Bob",
      "last_name": "Smith",
      "email": "my.everflow@gmail.com",
      "title": "",
      "work_phone": "9655433513",
      "cell_phone": "",
      "instant_messaging_id": 0,
      "instant_messaging_identifier": "",
      "language_id": 1,
      "timezone_id": 75,
      "currency_id": "USD",
      "account_status": "active",
      "relationship": {
        "affiliate_account_status": "active"
      }
    }
  ]
}

Retrieve all users for a specific affiliate. Returns user details including contact information, roles, and primary user designation.

Authorizations

X-Eflow-Api-Key

string

header

required

The Everflow API key generated from the Control Center > Security.

Path Parameters

affiliateId

integer

required

The ID of the affiliate whose users you want to fetch.

Query Parameters

relationship

enum<string>

Include additional related data in the response. Multiple relationships can be supplied by repeating the relationship query parameter. Supported values: logins (includes the users' list of logins), api (includes the users' API key and whitelisted IPs), affiliate_status (includes the status of the affiliate to which the user belongs), customizations (includes the users' customizations). affiliate_status populates relationship.affiliate_account_status (always returned, whether requested or not) and customizations populates relationship.customization (singular). An unrecognised value is ignored.

Available options:

logins,

api,

affiliate_status,

customizations

Response

200 - application/json

users

object[]

List of affiliate users.

Show child attributes