Referred Client(s)
This action retrieves information about end-user(s) you've referred to the White Swan.
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
Authorization*
String
Bearer <YOUR API KEY>
Content-Type*
String
application/json
Accept*
String
application/json
user-agent*
String
<YOUR APP>
Request Body
JSON Body*
Object
See specification below
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]"
}'
Body Parameters Specification:
Client Email
client_email
Text
This input can optionally be used to get information about a specific client.
Returned Parameters Specification:
Referred Client Name
name
Alice Johnson
The name 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.
Last updated
Was this helpful?