Referred Client(s)

This action retrieves information about end-user(s) you've referred to the White Swan.

The IDs returned by this action can be used in other information calls to retrieve further information about Plan Request(s) or Personal Plan(s) associated with a given client.

API Method:

Fetch Client(s)

POST https://app.whiteswan.io/api/1.1/wf/client

Returns information about referred end-users associated with your White Swan account.

Headers

Name

Type

Description

Authorization*

String

Bearer <YOUR API KEY>

Content-Type*

String

application/json

Accept*

String

application/json

user-agent*

String

Request Body

Name

Type

Description

JSON Body*

Object

See specification below

Sample Body Payload

{
"client_email": "[email protected]"
}

Please note that the sample body payload above contains all possible parameters for your reference. In an actual call, you don't need to use all (or any) parameters.

Code Examples - Making the API Call:

curl -X POST "https://app.whiteswan.io/api/1.1/wf/client" \
     -H "Authorization: Bearer <YOUR API KEY>" \
     -H "Content-Type: application/json" \
     -H "Accept: application/json" \
     -H "User-Agent: <YOUR APP>" \
     -d '{
               "client_email": "[email protected]"
          }'

import requests

url = "https://app.whiteswan.io/api/1.1/wf/client"
headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "User-Agent": "<YOUR APP>"
}

data = {
    "client_email": "[email protected]"
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const url = "https://app.whiteswan.io/api/1.1/wf/client";
const headers = {
    "Authorization": "Bearer <YOUR API KEY>",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "user-agent": "<YOUR APP>"
};
const data = {
    "client_email": "[email protected]"
};

fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error("Error:", error));

import okhttp3.*;

public class WhiteSwanApiCall {

    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();

        MediaType mediaType = MediaType.parse("application/json");
        RequestBody body = RequestBody.create(mediaType, "{\"client_email\":\"[email protected]\"}");

        Request request = new Request.Builder()
            .url("https://app.whiteswan.io/api/1.1/wf/client")
            .post(body)
            .addHeader("Authorization", "Bearer <YOUR API KEY>")
            .addHeader("Content-Type", "application/json")
            .addHeader("Accept", "application/json")
            .addHeader("user-agent", "<YOUR APP>")
            .build();

        try {
            Response response = client.newCall(request).execute();
            System.out.println(response.body().string());
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

<?php

$ch = curl_init();

$data = array(
    "client_email" => "[email protected]"
);

$headers = array(
    "Authorization: Bearer <YOUR API KEY>",
    "Content-Type: application/json",
    "Accept: application/json",
    "user-agent: <YOUR APP>"
);

curl_setopt($ch, CURLOPT_URL, "https://app.whiteswan.io/api/1.1/wf/client");
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
?>

require 'net/http'
require 'json'
require 'uri'

uri = URI.parse("https://app.whiteswan.io/api/1.1/wf/client")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

headers = {
  'Authorization' => 'Bearer <YOUR API KEY>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'User-Agent' => '<YOUR APP>'
}

data = {
    client_email: "[email protected]"
}

request = Net::HTTP::Post.new(uri.path, headers)
request.body = data.to_json

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

package main

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

func main() {
	url := "https://app.whiteswan.io/api/1.1/wf/client"
	data := `{
    			"client_email": "[email protected]"
		}`

	req, err := http.NewRequest("POST", url, bytes.NewBuffer([]byte(data)))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer <YOUR API KEY>")
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("User-Agent", "<YOUR APP>")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	fmt.Println("Response Status:", resp.Status)
}

Code examples are available in cURL, Python, Javascript, Java, PHP, Ruby, and Go, but can be constructed for other languages and tools. Some code examples include dependencies that may need to be installed in your codebase to ensure functionality. Remember to replace any values in the code that looks like <VALUE> and to adapt the parameter values passed.

Body Parameters Specification:

Field Label

Field Key

Field Type

Example Value

Description

Client Email

client_email

Text

[email protected]

This input can optionally be used to get information about a specific client.

Sample Return Payload

[{
"name": "Alice Johnson",
"email": "[email protected]",
"referrer": "Alex Johnson",
"associated_request_ids": [
          "1234567890x0987654321"
],
"associated_plan_ids": [
          "1234567890x1122334455"
]
}]

Returned Parameters Specification:

Field Label

Field Key

Example Value

Description

Referred Client Name

name

Alice Johnson

The name of the referred client.

Referred Client Email

[email protected]

The email address of the referred client.

Account User Referring Client

referrer

Alex Johnson

The name of the user on your White Swan account who referred the client.

Referred Client Associated Plan Request IDs

associated_request_ids

1234567890x0987654321

The ID of the plan request(s) associated with the referred client.

Referred Client Associated Personal Plan IDs

associated_plan_ids

1234567890x1122334455

The ID of the personal plan(s) associated with the referred client.

PreviousPersonal Plan(s)NextAccount User(s)

Last updated 2 years ago

Was this helpful?