Analytics and operations

Embed
Preview of the card
<a href="https://referalli.com/docs/ref-analytics-and-operations"><img src="https://referalli.com/docs/_api/public/orgs/07f432f4-34b9-46a7-aaad-c0e395d2e4f9/spaces/2bf4f614-3630-4fbf-85f9-5ecafa6b7d97/pages/3408dcfa-ec0d-4972-8d47-7375aff1bac2/social-card.svg?v=3e7ae33eec8b" alt="Analytics and operations" width="600" height="315"></a>
GEThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js
GET /t/{orgToken}/aff.js
Parameters
orgTokenstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/aff.js"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 The tracking script, generated for this token.
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}
GET /go/{orgToken}/{code}
Parameters
orgTokenstringpathrequired
codestringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/go/{orgToken}/{code}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
302 Redirects the browser.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/visit
POST /t/{orgToken}/visit
Parameters
orgTokenstringpathrequired
Request body application/json
anonIdstringrequired
clickIdstring
codestring
urlstring
refererstring
{
  "anonId": "string",
  "clickId": "string",
  "code": "string",
  "url": "string",
  "referer": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit" \
  -H "Content-Type: application/json" \
  -d '{"anonId":"string","clickId":"string","code":"string","url":"string","referer":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"anonId":"string","clickId":"string","code":"string","url":"string","referer":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit",
    headers={
    "Content-Type": "application/json",
    },
    json={"anonId": "string", "clickId": "string", "code": "string", "url": "string", "referer": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit", strings.NewReader(`{"anonId":"string","clickId":"string","code":"string","url":"string","referer":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"anonId":"string","clickId":"string","code":"string","url":"string","referer":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"anonId":"string","clickId":"string","code":"string","url":"string","referer":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/visit"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"anonId\":\"string\",\"clickId\":\"string\",\"code\":\"string\",\"url\":\"string\",\"referer\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "clickId": "string"
}
Schema
okbooleanrequired
clickIdstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}
GET /t/{orgToken}/codes/{code}
Parameters
orgTokenstringpathrequired
codestringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/codes/{code}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "valid": true,
  "partnerDisplayName": "string",
  "refereeReward": {
    "kind": "string",
    "bps": 0,
    "amountMinor": 0,
    "capMinor": 0,
    "currency": "string",
    "on": "string"
  }
}
Schema
validbooleanrequired
partnerDisplayNamestringrequired
First name only.
refereeRewardobjectrequired
Show child parameters
kindstringrequired
bpsinteger
amountMinorinteger
Integer minor units (cents).
capMinorinteger
Integer minor units (cents).
currencystringrequired
onstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/identify
POST /t/{orgToken}/identify
Parameters
orgTokenstringpathrequired
Request body application/json
anonIdstringrequired
customerRefstring
emailHashstring
{
  "anonId": "string",
  "customerRef": "string",
  "emailHash": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify" \
  -H "Content-Type: application/json" \
  -d '{"anonId":"string","customerRef":"string","emailHash":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"anonId":"string","customerRef":"string","emailHash":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify",
    headers={
    "Content-Type": "application/json",
    },
    json={"anonId": "string", "customerRef": "string", "emailHash": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify", strings.NewReader(`{"anonId":"string","customerRef":"string","emailHash":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"anonId":"string","customerRef":"string","emailHash":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"anonId":"string","customerRef":"string","emailHash":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/identify"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"anonId\":\"string\",\"customerRef\":\"string\",\"emailHash\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js
GET /t/{orgToken}/widget.js
Parameters
orgTokenstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget.js"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 The in-app referral widget (web component).
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me
GET /t/{orgToken}/widget/me
Parameters
orgTokenstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/widget/me"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "program": {
    "id": "string",
    "name": "string"
  },
  "partner": {
    "displayName": "string"
  },
  "code": "string",
  "coupon": "string",
  "link": "string",
  "share": {
    "x": "string",
    "facebook": "string",
    "linkedin": "string",
    "whatsapp": "string",
    "email": "string"
  },
  "progress": {
    "clicks": 0,
    "signups": 0,
    "payingCustomers": 0
  },
  "earnings": [
    {
      "currency": "string",
      "pending": 0,
      "approved": 0,
      "paid": 0
    }
  ],
  "refereeReward": {
    "kind": "string",
    "bps": 0,
    "amountMinor": 0,
    "capMinor": 0,
    "currency": "string",
    "on": "string"
  }
}
Schema
programobjectrequired
Show child parameters
idstringrequired
namestringrequired
partnerobjectrequired
Show child parameters
displayNamestringrequired
codestringrequired
couponstringrequired
linkstringrequired
shareobjectrequired
Show child parameters
xstringrequired
facebookstringrequired
linkedinstringrequired
whatsappstringrequired
emailstringrequired
progressobjectrequired
Show child parameters
clicksintegerrequired
signupsintegerrequired
payingCustomersintegerrequired
earningsobject[]required
Show child parameters
currencystringrequired
pendingintegerrequired
Integer minor units (cents).
approvedintegerrequired
Integer minor units (cents).
paidintegerrequired
Integer minor units (cents).
refereeRewardobjectrequired
Show child parameters
kindstringrequired
bpsinteger
amountMinorinteger
Integer minor units (cents).
capMinorinteger
Integer minor units (cents).
currencystringrequired
onstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/agents/register
POST /v1/agents/register
Request body application/json
walletAddressstringrequired
noncestringrequired
signaturestringrequired
namestring
modelstring
operatorstring
instantPayoutboolean
= false
{
  "walletAddress": "string",
  "nonce": "string",
  "signature": "string",
  "name": "string",
  "model": "string",
  "operator": "string",
  "instantPayout": false
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/agents/register" \
  -H "Content-Type: application/json" \
  -d '{"walletAddress":"string","nonce":"string","signature":"string","name":"string","model":"string","operator":"string","instantPayout":false}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/agents/register', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"walletAddress":"string","nonce":"string","signature":"string","name":"string","model":"string","operator":"string","instantPayout":false}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/agents/register",
    headers={
    "Content-Type": "application/json",
    },
    json={"walletAddress": "string", "nonce": "string", "signature": "string", "name": "string", "model": "string", "operator": "string", "instantPayout": False},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/agents/register", strings.NewReader(`{"walletAddress":"string","nonce":"string","signature":"string","name":"string","model":"string","operator":"string","instantPayout":false}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/agents/register');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"walletAddress":"string","nonce":"string","signature":"string","name":"string","model":"string","operator":"string","instantPayout":false}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/agents/register')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"walletAddress":"string","nonce":"string","signature":"string","name":"string","model":"string","operator":"string","instantPayout":false}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/agents/register"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"walletAddress\":\"string\",\"nonce\":\"string\",\"signature\":\"string\",\"name\":\"string\",\"model\":\"string\",\"operator\":\"string\",\"instantPayout\":false}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "agentId": "string",
  "wallet": "string",
  "instantPayout": true
}
Schema
agentIdstringrequired
walletstringrequired
instantPayoutbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute
POST /t/{orgToken}/agent/attribute
Parameters
orgTokenstringpathrequired
Request body application/json
walletAddressstringrequired
programIdstringrequired
customerRefstringrequired
noncestringrequired
signaturestringrequired
{
  "walletAddress": "string",
  "programId": "string",
  "customerRef": "string",
  "nonce": "string",
  "signature": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute" \
  -H "Content-Type: application/json" \
  -d '{"walletAddress":"string","programId":"string","customerRef":"string","nonce":"string","signature":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"walletAddress":"string","programId":"string","customerRef":"string","nonce":"string","signature":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute",
    headers={
    "Content-Type": "application/json",
    },
    json={"walletAddress": "string", "programId": "string", "customerRef": "string", "nonce": "string", "signature": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute", strings.NewReader(`{"walletAddress":"string","programId":"string","customerRef":"string","nonce":"string","signature":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"walletAddress":"string","programId":"string","customerRef":"string","nonce":"string","signature":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"walletAddress":"string","programId":"string","customerRef":"string","nonce":"string","signature":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/attribute"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"walletAddress\":\"string\",\"programId\":\"string\",\"customerRef\":\"string\",\"nonce\":\"string\",\"signature\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "attributed": true,
  "referralId": "string",
  "agentWallet": "string"
}
Schema
attributedbooleanrequired
referralIdstringrequired
agentWalletstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate
POST /t/{orgToken}/agent/negotiate
Parameters
orgTokenstringpathrequired
Request body application/json
walletAddressstringrequired
programIdstringrequired
proposedBpsintegerrequired
noncestringrequired
signaturestringrequired
{
  "walletAddress": "string",
  "programId": "string",
  "proposedBps": 0,
  "nonce": "string",
  "signature": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate" \
  -H "Content-Type: application/json" \
  -d '{"walletAddress":"string","programId":"string","proposedBps":0,"nonce":"string","signature":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"walletAddress":"string","programId":"string","proposedBps":0,"nonce":"string","signature":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate",
    headers={
    "Content-Type": "application/json",
    },
    json={"walletAddress": "string", "programId": "string", "proposedBps": 0, "nonce": "string", "signature": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate", strings.NewReader(`{"walletAddress":"string","programId":"string","proposedBps":0,"nonce":"string","signature":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"walletAddress":"string","programId":"string","proposedBps":0,"nonce":"string","signature":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"walletAddress":"string","programId":"string","proposedBps":0,"nonce":"string","signature":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/agent/negotiate"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"walletAddress\":\"string\",\"programId\":\"string\",\"proposedBps\":0,\"nonce\":\"string\",\"signature\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "decision": "accept",
  "rateBps": 0,
  "counterBps": 0,
  "partnerId": "string",
  "reason": "string"
}
Schema
decisionstringrequired
accept | counter | reject
rateBpsinteger
counterBpsinteger
partnerIdstring
reasonstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/consent
POST /t/{orgToken}/consent
Parameters
orgTokenstringpathrequired
Request body application/json
customerRefstringrequired
emailHashstring
purposesstring[]
= []
declaredobject
= {}
grantedboolean
= true
{
  "customerRef": "string",
  "emailHash": "string",
  "purposes": [],
  "declared": {},
  "granted": true
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent" \
  -H "Content-Type: application/json" \
  -d '{"customerRef":"string","emailHash":"string","purposes":[],"declared":{},"granted":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"customerRef":"string","emailHash":"string","purposes":[],"declared":{},"granted":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent",
    headers={
    "Content-Type": "application/json",
    },
    json={"customerRef": "string", "emailHash": "string", "purposes": [], "declared": {}, "granted": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent", strings.NewReader(`{"customerRef":"string","emailHash":"string","purposes":[],"declared":{},"granted":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"customerRef":"string","emailHash":"string","purposes":[],"declared":{},"granted":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"customerRef":"string","emailHash":"string","purposes":[],"declared":{},"granted":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/consent"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"customerRef\":\"string\",\"emailHash\":\"string\",\"purposes\":[],\"declared\":{},\"granted\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "customerRef": "string",
  "granted": true
}
Schema
okbooleanrequired
customerRefstringrequired
grantedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/health
GET /v1/health
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/health"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/health', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/health",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/health", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/health');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/health')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/health"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/versions
GET /v1/versions
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/versions"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/versions', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/versions",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/versions", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/versions');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/versions')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/versions"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "latest": "string",
  "versions": [
    {
      "version": "string",
      "released": "string",
      "changes": [
        "string"
      ]
    }
  ],
  "deprecationPolicy": "string"
}
Schema
lateststringrequired
versionsobject[]required
Show child parameters
versionstringrequired
releasedstringrequired
changesstring[]required
deprecationPolicystringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/auth/oidc/start
Begin browser sign-in (the deployment's OIDC provider)
Parameters
providerstringquery
instance | atlasid = instance
asstringquery
merchant | partner = merchant
nextstringquery
recruiterstringquery
login_hintstringquery
return_hoststringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/auth/oidc/start?provider=&as=&next=&recruiter=&login_hint=&return_host="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
302 Redirects the browser.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback
GET /v1/auth/oidc/callback
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/auth/oidc/callback"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
302 Redirects the browser.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/auth/handoff
GET /v1/auth/handoff
Parameters
codestringqueryrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/auth/handoff?code="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
302 Redirects the browser.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/auth/providers
GET /v1/auth/providers
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/auth/providers"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/auth/providers', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/auth/providers",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/auth/providers", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/auth/providers');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/auth/providers')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/auth/providers"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "providers": [
    "instance"
  ],
  "details": [
    {
      "id": "instance",
      "name": "string",
      "atlas": true
    }
  ]
}
Schema
providersstring[]required
detailsobject[]required
Show child parameters
idstringrequired
instance | atlasid
namestringrequired
The provider, for the sign-in button.
atlasbooleanrequired
Atlas, which has its own branded one-click button.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/auth/logout
POST /v1/auth/logout
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/auth/logout"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/auth/logout', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/auth/logout",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/auth/logout", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/auth/logout');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/auth/logout')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/auth/logout"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "logoutUrl": "string"
}
Schema
okbooleanrequired
logoutUrlstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/me
GET /v1/me
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/me"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/me', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/me",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/me", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/me');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/me')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/me"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "emailVerified": true
  },
  "memberships": [
    {
      "orgId": "string",
      "role": "string"
    }
  ],
  "apiKey": {
    "id": "string",
    "name": "string",
    "prefix": "string",
    "scopes": [
      "string"
    ],
    "apiVersion": "string",
    "livemode": true,
    "publishable": true,
    "owner": "string",
    "expiresAt": "2024-01-01T00:00:00Z"
  },
  "org": {
    "id": "string",
    "name": "string"
  }
}
Schema
userobjectrequired
Show child parameters
idstringrequired
emailstringrequired
namestringrequired
emailVerifiedbooleanrequired
membershipsobject[]required
Show child parameters
orgIdstringrequired
rolestringrequired
apiKeyobject
Set when called with an API key (user is then null).
Show child parameters
idstringrequired
namestringrequired
prefixstringrequired
scopesstring[]required
apiVersionstringrequired
The referally-version this key is pinned to.
livemodebooleanrequired
publishablebooleanrequired
ownerstringrequired
expiresAtstringrequired
orgobject
Show child parameters
idstringrequired
namestringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/hosts/current
GET /v1/hosts/current
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/hosts/current"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/hosts/current', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/hosts/current",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/hosts/current", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/hosts/current');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/hosts/current')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/hosts/current"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "kind": "string",
  "orgId": "string",
  "orgName": "string",
  "branding": {
    "logoUrl": "string",
    "theme": {}
  },
  "programs": [
    {
      "handle": "string",
      "name": "string"
    }
  ]
}
Option 1
kindstringrequired
A merchant's verified partner-portal domain.
orgIdstringrequired
orgNamestringrequired
brandingobjectrequired
Show child parameters
logoUrlstringrequired
themeobjectrequired
programsobject[]required
The org's active programs with a public signup page (/join/:handle).
Show child parameters
handlestringrequired
namestringrequired
{
  "kind": "string",
  "orgId": "string",
  "orgName": "string",
  "branding": {
    "logoUrl": "string",
    "theme": {}
  },
  "programs": [
    {
      "handle": "string",
      "name": "string"
    }
  ]
}
Option 2
kindstringrequired
A merchant's verified link domain.
{
  "kind": "string"
}
Option 3
kindstringrequired
Referally's own app.
{
  "kind": "string"
}
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css
GET /v1/hosts/current/theme.css
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/hosts/current/theme.css"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 The portal domain's theme tokens; empty on any other host.
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/auth/forumulate
GET /v1/auth/forumulate
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/auth/forumulate"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/auth/forumulate', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/auth/forumulate",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/auth/forumulate", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/auth/forumulate');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/auth/forumulate')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/auth/forumulate"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
302 Redirects the browser.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org
GET /v1/org
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "name": "string",
  "plan": "string",
  "settings": {},
  "trackingToken": "string",
  "payoutKycRequired": true,
  "livemode": true,
  "liveOrgId": "string"
}
Schema
idstringrequired
namestringrequired
planstringrequired
settingsobjectrequired
trackingTokenstringrequired
payoutKycRequiredbooleanrequired
livemodebooleanrequired
False for the org's test org (test mode).
liveOrgIdstring
On a test org: the live org it belongs to.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PATCHhttps://referally.15.204.158.166.sslip.io/v1/org
PATCH /v1/org
Request body application/json
namestring
settingsobject
payoutKycRequiredboolean
{
  "name": "string",
  "settings": {},
  "payoutKycRequired": true
}
Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/org" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","settings":{},"payoutKycRequired":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","settings":{},"payoutKycRequired":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PATCH",
    "https://referally.15.204.158.166.sslip.io/v1/org",
    headers={
    "Content-Type": "application/json",
    },
    json={"name": "string", "settings": {}, "payoutKycRequired": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/org", strings.NewReader(`{"name":"string","settings":{},"payoutKycRequired":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","settings":{},"payoutKycRequired":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","settings":{},"payoutKycRequired":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org"))
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"name\":\"string\",\"settings\":{},\"payoutKycRequired\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Note: this response uses the column names (payout_kyc_required); GET /v1/org is camelCase.
Example
{
  "id": "string",
  "name": "string",
  "plan": "string",
  "settings": {},
  "payout_kyc_required": true
}
Schema
idstringrequired
namestringrequired
planstringrequired
settingsobjectrequired
payout_kyc_requiredbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/members
GET /v1/org/members
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/members"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/members', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/members",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/members", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/members');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/members')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/members"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "userId": "string",
      "role": "owner",
      "email": "string",
      "name": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataMember[]required
Show child parameters
userIdstringrequired
rolestringrequired
owner | admin | finance | analyst | support
emailstringrequired
namestringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/org/members
POST /v1/org/members
Request body application/json
emailstringrequired
rolestringrequired
owner | admin | finance | analyst | support
{
  "email": "string",
  "role": "owner"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/org/members" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","role":"owner"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/members', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"email":"string","role":"owner"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/org/members",
    headers={
    "Content-Type": "application/json",
    },
    json={"email": "string", "role": "owner"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/org/members", strings.NewReader(`{"email":"string","role":"owner"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/members');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"email":"string","role":"owner"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/members')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"email":"string","role":"owner"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/members"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"email\":\"string\",\"role\":\"owner\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "userId": "string",
  "role": "string"
}
Schema
userIdstringrequired
rolestringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/org/members/{userId}
DELETE /v1/org/members/{userId}
Parameters
userIdstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PATCHhttps://referally.15.204.158.166.sslip.io/v1/org/members/{userId}
PATCH /v1/org/members/{userId}
Parameters
userIdstringpathrequired
Request body application/json
rolestringrequired
owner | admin | finance | analyst | support
{
  "role": "owner"
}
Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}" \
  -H "Content-Type: application/json" \
  -d '{"role":"owner"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"role":"owner"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PATCH",
    "https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}",
    headers={
    "Content-Type": "application/json",
    },
    json={"role": "owner"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}", strings.NewReader(`{"role":"owner"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"role":"owner"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"role":"owner"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/members/{userId}"))
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"role\":\"owner\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "userId": "string",
  "role": "string"
}
Schema
userIdstringrequired
rolestringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/payout-schedule
GET /v1/org/payout-schedule
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "schedule": {
    "kind": "string",
    "dayOfMonth": 0
  },
  "nextRunDate": "string",
  "programs": [
    {
      "programId": "string",
      "name": "string",
      "override": null,
      "nextRunDate": "string"
    }
  ]
}
Schema
schedulePayoutSchedulerequired
nextRunDatestringrequired
programsobject[]required
Show child parameters
programIdstringrequired
namestringrequired
overridePayoutSchedule | objectrequired
nextRunDatestringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/org/payout-schedule
PUT /v1/org/payout-schedule
Request body application/json
dayOfMonthinteger
scheduleobject
{
  "dayOfMonth": 0,
  "schedule": {
    "kind": "string",
    "dayOfMonth": 0
  }
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule" \
  -H "Content-Type: application/json" \
  -d '{"dayOfMonth":0,"schedule":{"kind":"string","dayOfMonth":0}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"dayOfMonth":0,"schedule":{"kind":"string","dayOfMonth":0}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule",
    headers={
    "Content-Type": "application/json",
    },
    json={"dayOfMonth": 0, "schedule": {"kind": "string", "dayOfMonth": 0}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule", strings.NewReader(`{"dayOfMonth":0,"schedule":{"kind":"string","dayOfMonth":0}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"dayOfMonth":0,"schedule":{"kind":"string","dayOfMonth":0}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"dayOfMonth":0,"schedule":{"kind":"string","dayOfMonth":0}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/payout-schedule"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"dayOfMonth\":0,\"schedule\":{\"kind\":\"string\",\"dayOfMonth\":0}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "dayOfMonth": 0,
  "schedule": {
    "kind": "string",
    "dayOfMonth": 0
  },
  "nextRunDate": "string"
}
Schema
dayOfMonthinteger
schedulePayoutSchedule
nextRunDatestring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/tax-profile
GET /v1/org/tax-profile
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/tax-profile"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/tax-profile', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/tax-profile",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/tax-profile", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/tax-profile');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/tax-profile')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/tax-profile"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "legalName": "string",
  "address": "string",
  "country": "string",
  "vatId": "string",
  "ein": "string",
  "domesticVatBps": 0,
  "viesCheck": true,
  "filingProvider": "string",
  "filingConnected": true
}
Schema
legalNamestringrequired
addressstringrequired
countrystringrequired
vatIdstringrequired
einstringrequired
domesticVatBpsintegerrequired
viesCheckbooleanrequired
filingProviderstringrequired
filingConnectedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/org/tax-profile
PUT /v1/org/tax-profile
Request body application/json
legalNamestring
addressstring
countrystring
vatIdstring
einstring
domesticVatBpsinteger
viesCheckboolean
{
  "legalName": "string",
  "address": "string",
  "country": "string",
  "vatId": "string",
  "ein": "string",
  "domesticVatBps": 0,
  "viesCheck": true
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/org/tax-profile" \
  -H "Content-Type: application/json" \
  -d '{"legalName":"string","address":"string","country":"string","vatId":"string","ein":"string","domesticVatBps":0,"viesCheck":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/tax-profile', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"legalName":"string","address":"string","country":"string","vatId":"string","ein":"string","domesticVatBps":0,"viesCheck":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/org/tax-profile",
    headers={
    "Content-Type": "application/json",
    },
    json={"legalName": "string", "address": "string", "country": "string", "vatId": "string", "ein": "string", "domesticVatBps": 0, "viesCheck": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/org/tax-profile", strings.NewReader(`{"legalName":"string","address":"string","country":"string","vatId":"string","ein":"string","domesticVatBps":0,"viesCheck":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/tax-profile');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"legalName":"string","address":"string","country":"string","vatId":"string","ein":"string","domesticVatBps":0,"viesCheck":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/tax-profile')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"legalName":"string","address":"string","country":"string","vatId":"string","ein":"string","domesticVatBps":0,"viesCheck":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/tax-profile"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"legalName\":\"string\",\"address\":\"string\",\"country\":\"string\",\"vatId\":\"string\",\"ein\":\"string\",\"domesticVatBps\":0,\"viesCheck\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "legalName": "string",
  "address": "string",
  "country": "string",
  "vatId": "string",
  "ein": "string",
  "domesticVatBps": 0,
  "viesCheck": true,
  "filingProvider": "string",
  "filingConnected": true
}
Schema
legalNamestringrequired
addressstringrequired
countrystringrequired
vatIdstringrequired
einstringrequired
domesticVatBpsintegerrequired
viesCheckbooleanrequired
filingProviderstringrequired
filingConnectedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice
GET /v1/payouts/{id}/invoice
Parameters
idstringpathrequired
formatstringquery
json | html = json
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/payouts/{id}/invoice?format="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 JSON by default; ?format=html returns a printable HTML invoice.
Example
{
  "number": "string",
  "issuedAt": "2024-01-01T00:00:00Z",
  "lines": [
    {}
  ],
  "vatNote": "string",
  "supplier": {
    "name": "string",
    "address": "string",
    "country": "string",
    "vatId": "string"
  },
  "customer": {
    "name": "string",
    "address": "string",
    "country": "string",
    "vatId": "string"
  },
  "currency": "string",
  "netMinor": 0,
  "vatTreatment": "reverse_charge",
  "vatRateBps": 0,
  "vatMinor": 0,
  "grossMinor": 0,
  "selfBilling": {
    "agreementVersion": "string",
    "acceptedAt": "2024-01-01T00:00:00Z"
  }
}
Schema
numberstringrequired
Sequential per merchant per year: SBI-2026-1, -2, …
issuedAtstringrequired
linesobject[]required
vatNotestringrequired
supplierobject
The partner. Absent on invoices issued before 2026-10.
Show child parameters
namestringrequired
addressstringrequired
countrystringrequired
vatIdstringrequired
customerobject
The merchant, issuing the invoice on the partner’s behalf.
Show child parameters
namestringrequired
addressstringrequired
countrystringrequired
vatIdstringrequired
currencystring
netMinorinteger
Integer minor units (cents).
vatTreatmentstring
reverse_charge | domestic | outside_scope
vatRateBpsinteger
vatMinorinteger
Integer minor units (cents).
grossMinorinteger
Integer minor units (cents).
selfBillingobject
Show child parameters
agreementVersionstringrequired
acceptedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/org/tax-filing
PUT /v1/org/tax-filing
Request body application/json
providerstringrequired
test | tax1099
credentialsobject
Show child parameters
apiKeystringrequired
baseUrlstring
{
  "provider": "test",
  "credentials": {
    "apiKey": "string",
    "baseUrl": "string"
  }
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/org/tax-filing" \
  -H "Content-Type: application/json" \
  -d '{"provider":"test","credentials":{"apiKey":"string","baseUrl":"string"}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/tax-filing', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"provider":"test","credentials":{"apiKey":"string","baseUrl":"string"}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/org/tax-filing",
    headers={
    "Content-Type": "application/json",
    },
    json={"provider": "test", "credentials": {"apiKey": "string", "baseUrl": "string"}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/org/tax-filing", strings.NewReader(`{"provider":"test","credentials":{"apiKey":"string","baseUrl":"string"}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/tax-filing');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"provider":"test","credentials":{"apiKey":"string","baseUrl":"string"}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/tax-filing')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"provider":"test","credentials":{"apiKey":"string","baseUrl":"string"}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/tax-filing"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"provider\":\"test\",\"credentials\":{\"apiKey\":\"string\",\"baseUrl\":\"string\"}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "provider": "test",
  "connected": true
}
Schema
providerstringrequired
test | tax1099
connectedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/status
GET /v1/status
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/status"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/status', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/status",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/status", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/status');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/status')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/status"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "state": "operational",
  "components": [
    {
      "id": "string",
      "state": "operational",
      "detail": {}
    }
  ],
  "openIncidents": [
    {
      "id": "string",
      "title": "string",
      "state": "investigating",
      "severity": "notice",
      "body": "string",
      "components": [
        "string"
      ],
      "startedAt": "2024-01-01T00:00:00Z",
      "resolvedAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "updates": [
        {
          "id": null,
          "body": null,
          "state": null,
          "createdAt": null
        }
      ]
    }
  ],
  "checkedAt": "2024-01-01T00:00:00Z"
}
Schema
statestringrequired
operational | degraded | major_outage
componentsobject[]required
Show child parameters
idstringrequired
statestringrequired
operational | degraded | major_outage
detailobjectrequired
openIncidentsIncident[]required
Show child parameters
idstringrequired
titlestringrequired
statestringrequired
investigating | identified | monitoring | resolved
severitystringrequired
notice | minor | major | critical | maintenance
bodystringrequired
componentsstring[]required
startedAtstringrequired
resolvedAtstringrequired
updatedAtstringrequired
updatesobject[]required
Show child parameters
idstringrequired
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
createdAtstringrequired
checkedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/status/incidents
GET /v1/status/incidents
Parameters
limitintegerquery
= 50
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/status/incidents?limit="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "title": "string",
      "state": "investigating",
      "severity": "notice",
      "body": "string",
      "components": [
        "string"
      ],
      "startedAt": "2024-01-01T00:00:00Z",
      "resolvedAt": "2024-01-01T00:00:00Z",
      "updatedAt": "2024-01-01T00:00:00Z",
      "updates": [
        {
          "id": null,
          "body": null,
          "state": null,
          "createdAt": null
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataIncident[]required
Show child parameters
idstringrequired
titlestringrequired
statestringrequired
investigating | identified | monitoring | resolved
severitystringrequired
notice | minor | major | critical | maintenance
bodystringrequired
componentsstring[]required
startedAtstringrequired
resolvedAtstringrequired
updatedAtstringrequired
updatesobject[]required
Show child parameters
idstringrequired
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/status/incidents.atom
GET /v1/status/incidents.atom
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/status/incidents.atom"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Atom feed of incidents, newest first.
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}
GET /v1/status/incidents/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/status/incidents/{id}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "title": "string",
  "state": "investigating",
  "severity": "notice",
  "body": "string",
  "components": [
    "string"
  ],
  "startedAt": "2024-01-01T00:00:00Z",
  "resolvedAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "updates": [
    {
      "id": "string",
      "body": "string",
      "state": "investigating",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
idstringrequired
titlestringrequired
statestringrequired
investigating | identified | monitoring | resolved
severitystringrequired
notice | minor | major | critical | maintenance
bodystringrequired
componentsstring[]required
startedAtstringrequired
resolvedAtstringrequired
updatedAtstringrequired
updatesobject[]required
Show child parameters
idstringrequired
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/status/incidents
POST /v1/admin/status/incidents
Request body application/json
titlestringrequired
severitystring
notice | minor | major | critical | maintenance = minor
statestring
investigating | identified | monitoring | resolved = investigating
bodystring
componentsstring[]
= []
startedAtstring
{
  "title": "string",
  "severity": "minor",
  "state": "investigating",
  "body": "",
  "components": [],
  "startedAt": "2024-01-01T00:00:00Z"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","severity":"minor","state":"investigating","body":"","components":[],"startedAt":"2024-01-01T00:00:00Z"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"title":"string","severity":"minor","state":"investigating","body":"","components":[],"startedAt":"2024-01-01T00:00:00Z"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents",
    headers={
    "Content-Type": "application/json",
    },
    json={"title": "string", "severity": "minor", "state": "investigating", "body": "", "components": [], "startedAt": "2024-01-01T00:00:00Z"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents", strings.NewReader(`{"title":"string","severity":"minor","state":"investigating","body":"","components":[],"startedAt":"2024-01-01T00:00:00Z"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"title":"string","severity":"minor","state":"investigating","body":"","components":[],"startedAt":"2024-01-01T00:00:00Z"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"title":"string","severity":"minor","state":"investigating","body":"","components":[],"startedAt":"2024-01-01T00:00:00Z"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"title\":\"string\",\"severity\":\"minor\",\"state\":\"investigating\",\"body\":\"\",\"components\":[],\"startedAt\":\"2024-01-01T00:00:00Z\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "title": "string",
  "state": "investigating",
  "severity": "notice",
  "body": "string",
  "components": [
    "string"
  ],
  "startedAt": "2024-01-01T00:00:00Z",
  "resolvedAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "updates": [
    {
      "id": "string",
      "body": "string",
      "state": "investigating",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
idstringrequired
titlestringrequired
statestringrequired
investigating | identified | monitoring | resolved
severitystringrequired
notice | minor | major | critical | maintenance
bodystringrequired
componentsstring[]required
startedAtstringrequired
resolvedAtstringrequired
updatedAtstringrequired
updatesobject[]required
Show child parameters
idstringrequired
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PATCHhttps://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}
PATCH /v1/admin/status/incidents/{id}
Parameters
idstringpathrequired
Request body application/json
titlestring
severitystring
notice | minor | major | critical | maintenance
statestring
investigating | identified | monitoring | resolved
bodystring
componentsstring[]
{
  "title": "string",
  "severity": "notice",
  "state": "investigating",
  "body": "string",
  "components": [
    "api"
  ]
}
Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}" \
  -H "Content-Type: application/json" \
  -d '{"title":"string","severity":"notice","state":"investigating","body":"string","components":["api"]}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"title":"string","severity":"notice","state":"investigating","body":"string","components":["api"]}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PATCH",
    "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}",
    headers={
    "Content-Type": "application/json",
    },
    json={"title": "string", "severity": "notice", "state": "investigating", "body": "string", "components": ["api"]},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}", strings.NewReader(`{"title":"string","severity":"notice","state":"investigating","body":"string","components":["api"]}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"title":"string","severity":"notice","state":"investigating","body":"string","components":["api"]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"title":"string","severity":"notice","state":"investigating","body":"string","components":["api"]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}"))
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"title\":\"string\",\"severity\":\"notice\",\"state\":\"investigating\",\"body\":\"string\",\"components\":[\"api\"]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "title": "string",
  "state": "investigating",
  "severity": "notice",
  "body": "string",
  "components": [
    "string"
  ],
  "startedAt": "2024-01-01T00:00:00Z",
  "resolvedAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "updates": [
    {
      "id": "string",
      "body": "string",
      "state": "investigating",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
idstringrequired
titlestringrequired
statestringrequired
investigating | identified | monitoring | resolved
severitystringrequired
notice | minor | major | critical | maintenance
bodystringrequired
componentsstring[]required
startedAtstringrequired
resolvedAtstringrequired
updatedAtstringrequired
updatesobject[]required
Show child parameters
idstringrequired
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates
POST /v1/admin/status/incidents/{id}/updates
Parameters
idstringpathrequired
Request body application/json
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
{
  "body": "string",
  "state": "investigating"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates" \
  -H "Content-Type: application/json" \
  -d '{"body":"string","state":"investigating"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"body":"string","state":"investigating"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates",
    headers={
    "Content-Type": "application/json",
    },
    json={"body": "string", "state": "investigating"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates", strings.NewReader(`{"body":"string","state":"investigating"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"body":"string","state":"investigating"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"body":"string","state":"investigating"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/status/incidents/{id}/updates"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"body\":\"string\",\"state\":\"investigating\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "title": "string",
  "state": "investigating",
  "severity": "notice",
  "body": "string",
  "components": [
    "string"
  ],
  "startedAt": "2024-01-01T00:00:00Z",
  "resolvedAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z",
  "updates": [
    {
      "id": "string",
      "body": "string",
      "state": "investigating",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ]
}
Schema
idstringrequired
titlestringrequired
statestringrequired
investigating | identified | monitoring | resolved
severitystringrequired
notice | minor | major | critical | maintenance
bodystringrequired
componentsstring[]required
startedAtstringrequired
resolvedAtstringrequired
updatedAtstringrequired
updatesobject[]required
Show child parameters
idstringrequired
bodystringrequired
statestringrequired
investigating | identified | monitoring | resolved
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/retention
GET /v1/org/retention
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/retention"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/retention', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/retention",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/retention", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/retention');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/retention')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/retention"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "policy": {
    "clicks": 0,
    "visits": 0,
    "billingPayloads": 0,
    "webhookDeliveries": 0,
    "notifications": 0,
    "auditLog": 0
  },
  "limits": {},
  "lastRun": {
    "at": "2024-01-01T00:00:00Z",
    "result": {}
  }
}
Schema
policyobjectrequired
Show child parameters
clicksintegerrequired
visitsintegerrequired
billingPayloadsintegerrequired
webhookDeliveriesintegerrequired
notificationsintegerrequired
auditLogintegerrequired
limitsobjectrequired
lastRunobjectrequired
Show child parameters
atstringrequired
resultobjectrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/org/retention
PUT /v1/org/retention
Request body application/json
clicksinteger
visitsinteger
billingPayloadsinteger
webhookDeliveriesinteger
notificationsinteger
auditLoginteger
{
  "clicks": 0,
  "visits": 0,
  "billingPayloads": 0,
  "webhookDeliveries": 0,
  "notifications": 0,
  "auditLog": 0
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/org/retention" \
  -H "Content-Type: application/json" \
  -d '{"clicks":0,"visits":0,"billingPayloads":0,"webhookDeliveries":0,"notifications":0,"auditLog":0}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/retention', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clicks":0,"visits":0,"billingPayloads":0,"webhookDeliveries":0,"notifications":0,"auditLog":0}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/org/retention",
    headers={
    "Content-Type": "application/json",
    },
    json={"clicks": 0, "visits": 0, "billingPayloads": 0, "webhookDeliveries": 0, "notifications": 0, "auditLog": 0},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/org/retention", strings.NewReader(`{"clicks":0,"visits":0,"billingPayloads":0,"webhookDeliveries":0,"notifications":0,"auditLog":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/retention');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clicks":0,"visits":0,"billingPayloads":0,"webhookDeliveries":0,"notifications":0,"auditLog":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/retention')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clicks":0,"visits":0,"billingPayloads":0,"webhookDeliveries":0,"notifications":0,"auditLog":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/retention"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"clicks\":0,\"visits\":0,\"billingPayloads\":0,\"webhookDeliveries\":0,\"notifications\":0,\"auditLog\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "policy": {
    "clicks": 0,
    "visits": 0,
    "billingPayloads": 0,
    "webhookDeliveries": 0,
    "notifications": 0,
    "auditLog": 0
  },
  "limits": {},
  "lastRun": {
    "at": "2024-01-01T00:00:00Z",
    "result": {}
  }
}
Schema
policyobjectrequired
Show child parameters
clicksintegerrequired
visitsintegerrequired
billingPayloadsintegerrequired
webhookDeliveriesintegerrequired
notificationsintegerrequired
auditLogintegerrequired
limitsobjectrequired
lastRunobjectrequired
Show child parameters
atstringrequired
resultobjectrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/referral-params
GET /v1/org/referral-params
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/referral-params"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/referral-params', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/referral-params",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/referral-params", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/referral-params');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/referral-params')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/referral-params"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "builtIn": [
    "string"
  ],
  "params": [
    "string"
  ]
}
Schema
builtInstring[]required
Always read: via, ref, aff.
paramsstring[]required
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/org/referral-params
PUT /v1/org/referral-params
Request body application/json
paramsstring[]required
{
  "params": [
    "string"
  ]
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/org/referral-params" \
  -H "Content-Type: application/json" \
  -d '{"params":["string"]}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/referral-params', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"params":["string"]}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/org/referral-params",
    headers={
    "Content-Type": "application/json",
    },
    json={"params": ["string"]},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/org/referral-params", strings.NewReader(`{"params":["string"]}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/referral-params');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"params":["string"]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/referral-params')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"params":["string"]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/referral-params"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"params\":[\"string\"]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "builtIn": [
    "string"
  ],
  "params": [
    "string"
  ]
}
Schema
builtInstring[]required
Always read: via, ref, aff.
paramsstring[]required
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/api-keys
GET /v1/api-keys
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/api-keys"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/api-keys', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/api-keys",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/api-keys", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/api-keys');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/api-keys')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/api-keys"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "prefix": "string",
      "scopes": [
        "string"
      ],
      "apiVersion": "string",
      "publishable": true,
      "allowedOrigins": [
        "string"
      ],
      "livemode": true,
      "owner": "string",
      "pairId": "string",
      "createdBy": {
        "type": null,
        "id": null
      },
      "expiresAt": "2024-01-01T00:00:00Z",
      "expired": true,
      "lastUsedAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z",
      "revokedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataApiKey[]required
Show child parameters
idstringrequired
namestringrequired
prefixstringrequired
scopesstring[]required
apiVersionstringrequired
The referally-version this key is pinned to.
publishablebooleanrequired
allowedOriginsstring[]required
livemodebooleanrequired
ownerstringrequired
The developer or service the key belongs to.
pairIdstringrequired
Shared by a live/test pair minted together.
createdByobjectrequired
Show child parameters
typestringrequired
api_key | user
idstringrequired
expiresAtstringrequired
expiredbooleanrequired
lastUsedAtstringrequired
Updated at most once a minute.
createdAtstringrequired
revokedAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/api-keys
POST /v1/api-keys
Request body application/json
namestringrequired
scopesstring[]
publishableboolean
allowedOriginsstring[]
apiVersionstring
modestring
live | test | both
ownerstring
expiresInDaysinteger
{
  "name": "string",
  "scopes": [
    "admin"
  ],
  "publishable": true,
  "allowedOrigins": [
    "string"
  ],
  "apiVersion": "string",
  "mode": "live",
  "owner": "string",
  "expiresInDays": 0
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/api-keys" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","scopes":["admin"],"publishable":true,"allowedOrigins":["string"],"apiVersion":"string","mode":"live","owner":"string","expiresInDays":0}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/api-keys', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","scopes":["admin"],"publishable":true,"allowedOrigins":["string"],"apiVersion":"string","mode":"live","owner":"string","expiresInDays":0}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/api-keys",
    headers={
    "Content-Type": "application/json",
    },
    json={"name": "string", "scopes": ["admin"], "publishable": True, "allowedOrigins": ["string"], "apiVersion": "string", "mode": "live", "owner": "string", "expiresInDays": 0},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/api-keys", strings.NewReader(`{"name":"string","scopes":["admin"],"publishable":true,"allowedOrigins":["string"],"apiVersion":"string","mode":"live","owner":"string","expiresInDays":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/api-keys');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","scopes":["admin"],"publishable":true,"allowedOrigins":["string"],"apiVersion":"string","mode":"live","owner":"string","expiresInDays":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/api-keys')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","scopes":["admin"],"publishable":true,"allowedOrigins":["string"],"apiVersion":"string","mode":"live","owner":"string","expiresInDays":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/api-keys"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"name\":\"string\",\"scopes\":[\"admin\"],\"publishable\":true,\"allowedOrigins\":[\"string\"],\"apiVersion\":\"string\",\"mode\":\"live\",\"owner\":\"string\",\"expiresInDays\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "key": "string",
  "scopes": [
    "string"
  ],
  "publishable": true,
  "allowedOrigins": [
    "string"
  ],
  "apiVersion": "string",
  "livemode": true,
  "owner": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "pairId": "string"
}
IssuedApiKey
idstringrequired
keystringrequired
The full key, shown once.
scopesstring[]required
publishablebooleanrequired
allowedOriginsstring[]required
apiVersionstringrequired
livemodebooleanrequired
False for a test-mode key (rk_test_…).
ownerstringrequired
expiresAtstringrequired
pairIdstringrequired
{
  "id": "string",
  "key": "string",
  "scopes": [
    "string"
  ],
  "publishable": true,
  "allowedOrigins": [
    "string"
  ],
  "apiVersion": "string",
  "livemode": true,
  "owner": "string",
  "expiresAt": "2024-01-01T00:00:00Z",
  "pairId": "string"
}
Option 2
pairIdstringrequired
liveobjectrequired
Show child parameters
idstringrequired
keystringrequired
The full key, shown once.
scopesstring[]required
publishablebooleanrequired
allowedOriginsstring[]required
apiVersionstringrequired
livemodebooleanrequired
False for a test-mode key (rk_test_…).
ownerstringrequired
expiresAtstringrequired
pairIdstringrequired
testobjectrequired
Show child parameters
idstringrequired
keystringrequired
The full key, shown once.
scopesstring[]required
publishablebooleanrequired
allowedOriginsstring[]required
apiVersionstringrequired
livemodebooleanrequired
False for a test-mode key (rk_test_…).
ownerstringrequired
expiresAtstringrequired
pairIdstringrequired
{
  "pairId": "string",
  "live": {
    "id": "string",
    "key": "string",
    "scopes": [
      "string"
    ],
    "publishable": true,
    "allowedOrigins": [
      "string"
    ],
    "apiVersion": "string",
    "livemode": true,
    "owner": "string",
    "expiresAt": "2024-01-01T00:00:00Z",
    "pairId": "string"
  },
  "test": {
    "id": "string",
    "key": "string",
    "scopes": [
      "string"
    ],
    "publishable": true,
    "allowedOrigins": [
      "string"
    ],
    "apiVersion": "string",
    "livemode": true,
    "owner": "string",
    "expiresAt": "2024-01-01T00:00:00Z",
    "pairId": "string"
  }
}
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/api-keys/{id}
GET /v1/api-keys/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "name": "string",
  "prefix": "string",
  "scopes": [
    "string"
  ],
  "apiVersion": "string",
  "publishable": true,
  "allowedOrigins": [
    "string"
  ],
  "livemode": true,
  "owner": "string",
  "pairId": "string",
  "createdBy": {
    "type": "api_key",
    "id": "string"
  },
  "expiresAt": "2024-01-01T00:00:00Z",
  "expired": true,
  "lastUsedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "revokedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
namestringrequired
prefixstringrequired
scopesstring[]required
apiVersionstringrequired
The referally-version this key is pinned to.
publishablebooleanrequired
allowedOriginsstring[]required
livemodebooleanrequired
ownerstringrequired
The developer or service the key belongs to.
pairIdstringrequired
Shared by a live/test pair minted together.
createdByobjectrequired
Show child parameters
typestringrequired
api_key | user
idstringrequired
expiresAtstringrequired
expiredbooleanrequired
lastUsedAtstringrequired
Updated at most once a minute.
createdAtstringrequired
revokedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/api-keys/{id}
DELETE /v1/api-keys/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "revoked": [
    "string"
  ]
}
Schema
okbooleanrequired
revokedstring[]required
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PATCHhttps://referally.15.204.158.166.sslip.io/v1/api-keys/{id}
PATCH /v1/api-keys/{id}
Parameters
idstringpathrequired
Request body application/json
apiVersionstring
ownerstring
expiresInDaysinteger
{
  "apiVersion": "string",
  "owner": "string",
  "expiresInDays": 0
}
Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}" \
  -H "Content-Type: application/json" \
  -d '{"apiVersion":"string","owner":"string","expiresInDays":0}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"apiVersion":"string","owner":"string","expiresInDays":0}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PATCH",
    "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}",
    headers={
    "Content-Type": "application/json",
    },
    json={"apiVersion": "string", "owner": "string", "expiresInDays": 0},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}", strings.NewReader(`{"apiVersion":"string","owner":"string","expiresInDays":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"apiVersion":"string","owner":"string","expiresInDays":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"apiVersion":"string","owner":"string","expiresInDays":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/api-keys/{id}"))
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"apiVersion\":\"string\",\"owner\":\"string\",\"expiresInDays\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "apiVersion": "string",
  "owner": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
apiVersionstringrequired
ownerstringrequired
expiresAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/audit-logs
GET /v1/audit-logs
Parameters
actorstringquery
actorTypestringquery
actionstringquery
subjectTypestringquery
subjectIdstringquery
created[gte]stringquery
created[lte]stringquery
limitintegerquery
= 50
starting_afterstringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/audit-logs?actor=&actorType=&action=&subjectType=&subjectId=&created%5Bgte%5D=&created%5Blte%5D=&limit=&starting_after="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "actorType": "string",
      "actorId": "string",
      "action": "string",
      "subjectType": "string",
      "subjectId": "string",
      "data": {},
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataAuditLogEntry[]required
Show child parameters
idstringrequired
actorTypestringrequired
actorIdstringrequired
actionstringrequired
subjectTypestringrequired
subjectIdstringrequired
dataobjectrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/test_clock
GET /v1/test_clock
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/test_clock"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/test_clock', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/test_clock",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/test_clock", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/test_clock');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/test_clock')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/test_clock"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "now": "2024-01-01T00:00:00Z",
  "offsetSeconds": 0
}
Schema
nowstringrequired
offsetSecondsintegerrequired
How far the test clock is ahead of real time.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/test_clock/advance
POST /v1/test_clock/advance
Request body application/json
secondsintegerrequired
{
  "seconds": 0
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/test_clock/advance" \
  -H "Content-Type: application/json" \
  -d '{"seconds":0}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/test_clock/advance', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"seconds":0}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/test_clock/advance",
    headers={
    "Content-Type": "application/json",
    },
    json={"seconds": 0},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/test_clock/advance", strings.NewReader(`{"seconds":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/test_clock/advance');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"seconds":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/test_clock/advance')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"seconds":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/test_clock/advance"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"seconds\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "now": "2024-01-01T00:00:00Z",
  "offsetSeconds": 0,
  "approved": 0,
  "payoutRuns": 0
}
Schema
nowstringrequired
offsetSecondsintegerrequired
approvedintegerrequired
Held commission lines approved because their hold ended.
payoutRunsintegerrequired
Scheduled payout runs that fell due and ran.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/test/emails
GET /v1/test/emails
Parameters
limitintegerquery
= 50
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/test/emails?limit="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/test/emails?limit=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/test/emails?limit=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/test/emails?limit=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/test/emails?limit=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/test/emails?limit=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/test/emails?limit="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "event": "string",
      "to": "string",
      "subject": "string",
      "text": "string",
      "html": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
eventstringrequired
tostringrequired
subjectstringrequired
textstringrequired
htmlstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/cli/device-codes
POST /v1/cli/device-codes
Request body application/json
clientNamestring
{
  "clientName": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes" \
  -H "Content-Type: application/json" \
  -d '{"clientName":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientName":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientName": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes", strings.NewReader(`{"clientName":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/device-codes');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clientName":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientName":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/device-codes"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"clientName\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "deviceCode": "string",
  "userCode": "string",
  "verificationUri": "string",
  "verificationUriComplete": "string",
  "expiresIn": 0,
  "interval": 0
}
Schema
deviceCodestringrequired
Secret: the CLI polls with it.
userCodestringrequired
verificationUristringrequired
verificationUriCompletestringrequired
expiresInintegerrequired
intervalintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token
POST /v1/cli/device-codes/token
Request body application/json
deviceCodestringrequired
{
  "deviceCode": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token" \
  -H "Content-Type: application/json" \
  -d '{"deviceCode":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"deviceCode":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token",
    headers={
    "Content-Type": "application/json",
    },
    json={"deviceCode": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token", strings.NewReader(`{"deviceCode":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"deviceCode":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"deviceCode":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/token"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"deviceCode\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "status": "pending",
  "key": "string",
  "orgId": "string",
  "orgName": "string",
  "scopes": [
    "string"
  ]
}
Schema
statusstringrequired
pending | approved | denied | expired | consumed
keystring
The issued API key, returned once when approved.
orgIdstring
orgNamestring
scopesstring[]
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}
GET /v1/cli/device-codes/{userCode}
Parameters
userCodestringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "userCode": "string",
  "clientName": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
userCodestringrequired
clientNamestringrequired
createdAtstringrequired
expiresAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve
POST /v1/cli/device-codes/{userCode}/approve
Parameters
userCodestringpathrequired
Request body application/json
accessstring
full | read | cli = cli
namestring
{
  "access": "cli",
  "name": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve" \
  -H "Content-Type: application/json" \
  -d '{"access":"cli","name":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"access":"cli","name":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve",
    headers={
    "Content-Type": "application/json",
    },
    json={"access": "cli", "name": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve", strings.NewReader(`{"access":"cli","name":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"access":"cli","name":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"access":"cli","name":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/approve"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"access\":\"cli\",\"name\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "keyId": "string",
  "scopes": [
    "string"
  ]
}
Schema
okbooleanrequired
keyIdstringrequired
scopesstring[]required
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny
POST /v1/cli/device-codes/{userCode}/deny
Parameters
userCodestringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/device-codes/{userCode}/deny"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/cli/listeners
POST /v1/cli/listeners
Request body application/json
topicsstring[]
forwardTostring
{
  "topics": [
    "string"
  ],
  "forwardTo": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/cli/listeners" \
  -H "Content-Type: application/json" \
  -d '{"topics":["string"],"forwardTo":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/listeners', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"topics":["string"],"forwardTo":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/cli/listeners",
    headers={
    "Content-Type": "application/json",
    },
    json={"topics": ["string"], "forwardTo": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/cli/listeners", strings.NewReader(`{"topics":["string"],"forwardTo":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/listeners');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"topics":["string"],"forwardTo":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/listeners')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"topics":["string"],"forwardTo":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/listeners"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"topics\":[\"string\"],\"forwardTo\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "secret": "string",
  "topics": [
    "string"
  ],
  "idleTimeoutSec": 0
}
Schema
idstringrequired
secretstringrequired
Signs forwarded events (Standard Webhooks); shown once.
topicsstring[]required
idleTimeoutSecintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events
GET /v1/cli/listeners/{id}/events
Parameters
idstringpathrequired
waitintegerquery
= 0
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}/events?wait="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "events": [
    {
      "id": "string",
      "eventId": "string",
      "topic": "string",
      "body": "string",
      "headers": {}
    }
  ]
}
Schema
eventsobject[]required
Show child parameters
idstringrequired
eventIdstringrequired
topicstringrequired
bodystringrequired
The exact bytes to forward.
headersobjectrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}
DELETE /v1/cli/listeners/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/listeners/{id}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/cli/trigger
POST /v1/cli/trigger
Request body application/json
topicstringrequired
dataobject
{
  "topic": "string",
  "data": {}
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/cli/trigger" \
  -H "Content-Type: application/json" \
  -d '{"topic":"string","data":{}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/trigger', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"topic":"string","data":{}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/cli/trigger",
    headers={
    "Content-Type": "application/json",
    },
    json={"topic": "string", "data": {}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/cli/trigger", strings.NewReader(`{"topic":"string","data":{}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/trigger');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"topic":"string","data":{}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/trigger')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"topic":"string","data":{}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/trigger"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"topic\":\"string\",\"data\":{}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "eventId": "string",
  "topic": "string",
  "payload": {},
  "deliveredTo": {
    "listeners": 0,
    "endpoints": 0
  }
}
Schema
eventIdstringrequired
topicstringrequired
payloadobjectrequired
deliveredToobjectrequired
Show child parameters
listenersintegerrequired
endpointsintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/cli/topics
GET /v1/cli/topics
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/cli/topics"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/topics', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/cli/topics",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/cli/topics", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/topics');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/topics')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/topics"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "topics": [
    "string"
  ]
}
Schema
topicsstring[]required
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/cli/logs
GET /v1/cli/logs
Parameters
afterintegerquery
waitintegerquery
= 0
limitintegerquery
= 50
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cli/logs?after=&wait=&limit="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "entries": [
    {
      "seq": 0,
      "requestId": "string",
      "method": "string",
      "path": "string",
      "status": 0,
      "latencyMs": 0,
      "actorType": "string",
      "actorId": "string",
      "ts": "2024-01-01T00:00:00Z"
    }
  ],
  "cursor": 0
}
Schema
entriesobject[]required
Show child parameters
seqintegerrequired
requestIdstringrequired
methodstringrequired
pathstringrequired
statusintegerrequired
latencyMsintegerrequired
actorTypestringrequired
actorIdstringrequired
tsstringrequired
cursorintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/widget/tokens
POST /v1/widget/tokens
Request body application/json
programIdstringrequired
customerRefstring
partnerExternalRefstring
emailstring
displayNamestring
ttlSecondsinteger
{
  "programId": "string",
  "customerRef": "string",
  "partnerExternalRef": "string",
  "email": "string",
  "displayName": "string",
  "ttlSeconds": 0
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/widget/tokens" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","customerRef":"string","partnerExternalRef":"string","email":"string","displayName":"string","ttlSeconds":0}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/widget/tokens', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","customerRef":"string","partnerExternalRef":"string","email":"string","displayName":"string","ttlSeconds":0}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/widget/tokens",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "customerRef": "string", "partnerExternalRef": "string", "email": "string", "displayName": "string", "ttlSeconds": 0},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/widget/tokens", strings.NewReader(`{"programId":"string","customerRef":"string","partnerExternalRef":"string","email":"string","displayName":"string","ttlSeconds":0}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/widget/tokens');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","customerRef":"string","partnerExternalRef":"string","email":"string","displayName":"string","ttlSeconds":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/widget/tokens')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","customerRef":"string","partnerExternalRef":"string","email":"string","displayName":"string","ttlSeconds":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/widget/tokens"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"programId\":\"string\",\"customerRef\":\"string\",\"partnerExternalRef\":\"string\",\"email\":\"string\",\"displayName\":\"string\",\"ttlSeconds\":0}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "token": "string",
  "partnerId": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
tokenstringrequired
partnerIdstringrequired
expiresAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/track/events
POST /v1/track/events
Request body application/json
Example
{
  "programId": "string",
  "partnerId": "string",
  "linkId": "string",
  "url": "",
  "anonId": "string",
  "ip": "string",
  "ua": "string",
  "type": "string"
}
Option 1
programIdstringrequired
partnerIdstringrequired
linkIdstring
urlstring
anonIdstring
ipstring
uastring
typestringrequired
{
  "programId": "string",
  "partnerId": "string",
  "linkId": "string",
  "url": "",
  "anonId": "string",
  "ip": "string",
  "ua": "string",
  "type": "string"
}
Option 2
programIdstringrequired
partnerIdstringrequired
linkIdstring
urlstring
anonIdstring
ipstring
uastring
typestringrequired
{
  "programId": "string",
  "partnerId": "string",
  "linkId": "string",
  "url": "",
  "anonId": "string",
  "ip": "string",
  "ua": "string",
  "type": "string"
}
Option 3
typestringrequired
programIdstringrequired
customerRefstringrequired
eventstringrequired
occurredAtstring
idempotencyKeystring
{
  "type": "string",
  "programId": "string",
  "customerRef": "string",
  "event": "string",
  "occurredAt": "2024-01-01T00:00:00Z",
  "idempotencyKey": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/track/events" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","partnerId":"string","linkId":"string","url":"","anonId":"string","ip":"string","ua":"string","type":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/track/events', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","partnerId":"string","linkId":"string","url":"","anonId":"string","ip":"string","ua":"string","type":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/track/events",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "partnerId": "string", "linkId": "string", "url": "", "anonId": "string", "ip": "string", "ua": "string", "type": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/track/events", strings.NewReader(`{"programId":"string","partnerId":"string","linkId":"string","url":"","anonId":"string","ip":"string","ua":"string","type":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/track/events');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","partnerId":"string","linkId":"string","url":"","anonId":"string","ip":"string","ua":"string","type":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/track/events')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","partnerId":"string","linkId":"string","url":"","anonId":"string","ip":"string","ua":"string","type":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/track/events"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"programId\":\"string\",\"partnerId\":\"string\",\"linkId\":\"string\",\"url\":\"\",\"anonId\":\"string\",\"ip\":\"string\",\"ua\":\"string\",\"type\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "clickId": "string",
  "eventId": "string",
  "event": "string",
  "recorded": true,
  "referralId": "string",
  "duplicate": true,
  "commissionId": "string",
  "amountMinor": 0,
  "currency": "string"
}
Schema
clickIdstring
eventIdstring
eventstring
recordedboolean
referralIdstring
duplicateboolean
commissionIdstring
amountMinorinteger
Integer minor units (cents).
currencystring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/payouts
GET /v1/payouts
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/payouts"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/payouts', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/payouts",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/payouts", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/payouts');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/payouts')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/payouts"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "runId": "string",
      "partnerId": "string",
      "amountMinor": 0,
      "currency": "string",
      "status": "string",
      "rail": "string",
      "railRef": "string",
      "failureReason": "string",
      "sentAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataPayout[]required
Show child parameters
idstringrequired
runIdstringrequired
partnerIdstringrequired
amountMinorintegerrequired
Integer minor units (cents).
currencystringrequired
statusstringrequired
railstringrequired
railRefstringrequired
failureReasonstringrequired
sentAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/fx-feed
GET /v1/org/fx-feed
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/fx-feed"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/fx-feed', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/fx-feed",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/fx-feed", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/fx-feed');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/fx-feed')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/fx-feed"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "enabled": true,
  "source": "string",
  "lastRateDate": "string"
}
Schema
enabledbooleanrequired
sourcestringrequired
lastRateDatestringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/org/fx-feed
PUT /v1/org/fx-feed
Request body application/json
enabledbooleanrequired
{
  "enabled": true
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/org/fx-feed" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/fx-feed', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"enabled":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/org/fx-feed",
    headers={
    "Content-Type": "application/json",
    },
    json={"enabled": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/org/fx-feed", strings.NewReader(`{"enabled":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/fx-feed');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"enabled":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/fx-feed')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"enabled":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/fx-feed"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"enabled\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "enabled": true,
  "source": "string",
  "synced": 0
}
Schema
enabledbooleanrequired
sourcestringrequired
syncedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/payout-connections
GET /v1/payout-connections
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/payout-connections"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/payout-connections', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/payout-connections",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/payout-connections", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/payout-connections');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/payout-connections')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/payout-connections"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "provider": "string",
      "env": "string",
      "status": "string",
      "connectedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
providerstringrequired
envstringrequired
statusstringrequired
connectedAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}
PUT /v1/payout-connections/{provider}
Parameters
providerstringpathrequired
Request body application/json
Example
{
  "clientId": "string",
  "secret": "string",
  "env": "sandbox"
}
Option 1
clientIdstringrequired
secretstringrequired
envstring
sandbox | live = sandbox
{
  "clientId": "string",
  "secret": "string",
  "env": "sandbox"
}
Option 2
secretKeystringrequired
envstring
sandbox | live = live
{
  "secretKey": "string",
  "env": "live"
}
Option 3
apiKeystringrequired
walletIdstringrequired
defaultChainstring
envstring
sandbox | live = sandbox
{
  "apiKey": "string",
  "walletId": "string",
  "defaultChain": "string",
  "env": "sandbox"
}
Option 4
apiTokenstringrequired
profileIdstringrequired
envstring
sandbox | live = sandbox
{
  "apiToken": "string",
  "profileId": "string",
  "env": "sandbox"
}
Option 5
clientIdstringrequired
secretstringrequired
programIdstringrequired
envstring
sandbox | live = sandbox
{
  "clientId": "string",
  "secret": "string",
  "programId": "string",
  "env": "sandbox"
}
Option 6
apiKeystringrequired
fundingSourceIdstringrequired
campaignIdstring
envstring
sandbox | live = sandbox
{
  "apiKey": "string",
  "fundingSourceId": "string",
  "campaignId": "string",
  "env": "sandbox"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}" \
  -H "Content-Type: application/json" \
  -d '{"clientId":"string","secret":"string","env":"sandbox"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"clientId":"string","secret":"string","env":"sandbox"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}",
    headers={
    "Content-Type": "application/json",
    },
    json={"clientId": "string", "secret": "string", "env": "sandbox"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}", strings.NewReader(`{"clientId":"string","secret":"string","env":"sandbox"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"clientId":"string","secret":"string","env":"sandbox"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"clientId":"string","secret":"string","env":"sandbox"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"clientId\":\"string\",\"secret\":\"string\",\"env\":\"sandbox\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "provider": "string",
  "env": "string",
  "status": "string"
}
Schema
providerstringrequired
envstringrequired
statusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}
DELETE /v1/payout-connections/{provider}
Parameters
providerstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/payout-connections/{provider}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "provider": "string",
  "removed": true
}
Schema
providerstringrequired
removedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan
POST /v1/fraud/invalid-traffic/scan
Request body application/json
windowHoursinteger
= 24
{
  "windowHours": 24
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan" \
  -H "Content-Type: application/json" \
  -d '{"windowHours":24}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"windowHours":24}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan",
    headers={
    "Content-Type": "application/json",
    },
    json={"windowHours": 24},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan", strings.NewReader(`{"windowHours":24}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"windowHours":24}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"windowHours":24}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/fraud/invalid-traffic/scan"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"windowHours\":24}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "window": "string",
  "partners": [
    {
      "partnerId": "string",
      "clicks": 0,
      "probability": 0,
      "label": "clean",
      "contributions": {}
    }
  ],
  "flagged": 0
}
Schema
windowstringrequired
partnersobject[]required
Show child parameters
partnerIdstringrequired
clicksintegerrequired
probabilitynumberrequired
labelstringrequired
clean | suspicious | invalid
contributionsobjectrequired
flaggedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/fraud/cases
Fraud case queue
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/fraud/cases"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/fraud/cases', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/fraud/cases",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/fraud/cases", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/fraud/cases');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/fraud/cases')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/fraud/cases"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "partnerId": "string",
      "referralId": "string",
      "kind": "string",
      "status": "string",
      "evidence": {},
      "action": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "resolvedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataFraudCase[]required
Show child parameters
idstringrequired
partnerIdstringrequired
referralIdstringrequired
kindstringrequired
statusstringrequired
evidenceGetOpenapiJsonResponserequired
actionstringrequired
createdAtstringrequired
resolvedAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve
POST /v1/fraud/cases/{id}/resolve
Parameters
idstringpathrequired
Request body application/json
actionstringrequired
dismiss | void_referral | suspend_partner | ban_partner
{
  "action": "dismiss"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve" \
  -H "Content-Type: application/json" \
  -d '{"action":"dismiss"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"action":"dismiss"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve",
    headers={
    "Content-Type": "application/json",
    },
    json={"action": "dismiss"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve", strings.NewReader(`{"action":"dismiss"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"action":"dismiss"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"action":"dismiss"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/fraud/cases/{id}/resolve"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"action\":\"dismiss\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/quality/recompute
POST /v1/quality/recompute
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/quality/recompute"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/quality/recompute', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/quality/recompute",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/quality/recompute", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/quality/recompute');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/quality/recompute')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/quality/recompute"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "partners": 0,
  "casesOpened": 0,
  "suspended": 0
}
Schema
partnersintegerrequired
casesOpenedintegerrequired
suspendedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings
POST /v1/fraud/detect-rings
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/fraud/detect-rings"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ringsFound": 0
}
Schema
ringsFoundintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks
GET /v1/reports/filtered-clicks
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/reports/filtered-clicks"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "day": "2024-01-01T00:00:00Z",
      "filtered": 0,
      "total": 0,
      "avgScore": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
daystringrequired
filteredintegerrequired
totalintegerrequired
avgScorenumberrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/analytics/overview
Funnel + revenue overview
Parameters
programIdstringquery
daysintegerquery
= 30
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/analytics/overview?programId=&days="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "clicks": 0,
  "filteredClicks": 0,
  "visitors": 0,
  "signups": 0,
  "payments": 0,
  "revenueMinor": 0,
  "commissionEarnedMinor": 0,
  "commissionReversedMinor": 0,
  "activePartners": 0,
  "funnel": {
    "clickToSignup": 0,
    "signupToPaid": 0
  }
}
Schema
clicksintegerrequired
filteredClicksintegerrequired
visitorsintegerrequired
signupsintegerrequired
paymentsintegerrequired
revenueMinorintegerrequired
Integer minor units (cents).
commissionEarnedMinorintegerrequired
Integer minor units (cents).
commissionReversedMinorintegerrequired
Integer minor units (cents).
activePartnersintegerrequired
funnelobjectrequired
Show child parameters
clickToSignupnumberrequired
signupToPaidnumberrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/analytics/timeseries
GET /v1/analytics/timeseries
Parameters
metricstringqueryrequired
clicks | signups | revenue
daysintegerquery
= 30
programIdstringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/analytics/timeseries?metric=&days=&programId="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "day": "2024-01-01T00:00:00Z",
      "value": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
daystringrequired
valuenumberrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv
GET /v1/analytics/cohort-ltv
Parameters
monthsintegerquery
= 6
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/analytics/cohort-ltv?months="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "cohort": "string",
      "customers": 0,
      "revenueMinor": 0,
      "ltvMinor": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
cohortstringrequired
customersintegerrequired
revenueMinorintegerrequired
Integer minor units (cents).
ltvMinorintegerrequired
Integer minor units (cents).
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/analytics/by-geo
GET /v1/analytics/by-geo
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/analytics/by-geo"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "geo": "string",
      "referrals": 0,
      "revenueMinor": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
geostringrequired
referralsintegerrequired
revenueMinorintegerrequired
Integer minor units (cents).
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/analytics/by-channel
GET /v1/analytics/by-channel
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/analytics/by-channel"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "channel": "string",
      "referrals": 0,
      "revenueMinor": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
channelstringrequired
referralsintegerrequired
revenueMinorintegerrequired
Integer minor units (cents).
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance
GET /v1/analytics/coupon-performance
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/analytics/coupon-performance"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "code": "string",
      "partnerId": "string",
      "referrals": 0,
      "revenueMinor": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
codestringrequired
partnerIdstringrequired
referralsintegerrequired
revenueMinorintegerrequired
Integer minor units (cents).
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/reports/partner-performance
GET /v1/reports/partner-performance
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/reports/partner-performance"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 JSON by default; text/csv with ?format=csv.
Example
[
  {
    "partnerId": "string",
    "displayName": "string",
    "email": "string",
    "status": "string",
    "clicks": 0,
    "referrals": 0,
    "payments": 0,
    "revenueMinor": 0,
    "earnedMinor": 0,
    "reversedMinor": 0
  }
]
Schema
partnerIdstringrequired
displayNamestringrequired
emailstringrequired
statusstringrequired
clicksintegerrequired
referralsintegerrequired
paymentsintegerrequired
revenueMinorintegerrequired
Integer minor units (cents).
earnedMinorintegerrequired
Integer minor units (cents).
reversedMinorintegerrequired
Integer minor units (cents).
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/openapi.json
GET /v1/openapi.json
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/openapi.json"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/openapi.json', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/openapi.json",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/openapi.json", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/openapi.json');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/openapi.json')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/openapi.json"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 This document.
{}
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/branding
GET /v1/branding
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/branding"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/branding",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/branding", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "logoUrl": "string",
  "theme": {},
  "portalDomain": "string",
  "portalDomainVerified": true,
  "portalDomainStatus": "none",
  "linkDomain": "string",
  "linkDomainVerified": true,
  "linkDomainStatus": "none",
  "emailFrom": "string"
}
Schema
logoUrlstringrequired
themeGetOpenapiJsonResponserequired
portalDomainstringrequired
portalDomainVerifiedbooleanrequired
portalDomainStatusstringrequired
none; pending (waiting for DNS); provisioning (routed here, certificate being issued); active (links/portal served on it).
none | pending | provisioning | active
linkDomainstringrequired
linkDomainVerifiedbooleanrequired
linkDomainStatusstringrequired
none; pending (waiting for DNS); provisioning (routed here, certificate being issued); active (links/portal served on it).
none | pending | provisioning | active
emailFromstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/branding
PUT /v1/branding
Request body application/json
logoUrlstring
themeobject
emailFromstring
{
  "logoUrl": "string",
  "theme": {},
  "emailFrom": "string"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/branding" \
  -H "Content-Type: application/json" \
  -d '{"logoUrl":"string","theme":{},"emailFrom":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"logoUrl":"string","theme":{},"emailFrom":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/branding",
    headers={
    "Content-Type": "application/json",
    },
    json={"logoUrl": "string", "theme": {}, "emailFrom": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/branding", strings.NewReader(`{"logoUrl":"string","theme":{},"emailFrom":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"logoUrl":"string","theme":{},"emailFrom":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"logoUrl":"string","theme":{},"emailFrom":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"logoUrl\":\"string\",\"theme\":{},\"emailFrom\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/branding/link-domain
POST /v1/branding/link-domain
Request body application/json
domainstringrequired
{
  "domain": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding/link-domain', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"domain":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain",
    headers={
    "Content-Type": "application/json",
    },
    json={"domain": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain", strings.NewReader(`{"domain":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding/link-domain');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"domain":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding/link-domain')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"domain":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding/link-domain"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"domain\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "domain": "string",
  "cnameTarget": "string",
  "txtRecord": "string",
  "txtName": "string",
  "verified": true
}
Schema
domainstringrequired
cnameTargetstringrequired
txtRecordstringrequired
txtNamestringrequired
verifiedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/branding/link-domain
DELETE /v1/branding/link-domain
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding/link-domain', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding/link-domain');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding/link-domain')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding/link-domain"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify
POST /v1/branding/link-domain/verify
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding/link-domain/verify"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "domain": "string",
  "verified": true,
  "status": "provisioning",
  "message": "string"
}
Schema
domainstringrequired
verifiedbooleanrequired
statusstringrequired
provisioning | active
messagestring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/branding/domain
POST /v1/branding/domain
Request body application/json
domainstringrequired
{
  "domain": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/branding/domain" \
  -H "Content-Type: application/json" \
  -d '{"domain":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding/domain', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"domain":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/branding/domain",
    headers={
    "Content-Type": "application/json",
    },
    json={"domain": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/branding/domain", strings.NewReader(`{"domain":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding/domain');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"domain":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding/domain')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"domain":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding/domain"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"domain\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "domain": "string",
  "cnameTarget": "string",
  "txtRecord": "string",
  "txtName": "string",
  "verified": true,
  "instructions": "string"
}
Schema
domainstringrequired
cnameTargetstringrequired
txtRecordstringrequired
txtNamestringrequired
verifiedbooleanrequired
instructionsstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/branding/domain
DELETE /v1/branding/domain
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/branding/domain"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding/domain', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/branding/domain",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/branding/domain", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding/domain');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding/domain')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding/domain"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/branding/domain/verify
POST /v1/branding/domain/verify
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/branding/domain/verify"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "domain": "string",
  "verified": true,
  "status": "provisioning",
  "message": "string"
}
Schema
domainstringrequired
verifiedbooleanrequired
statusstringrequired
provisioning | active
messagestring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/embed/tokens
POST /v1/embed/tokens
Request body application/json
partnerEmailstringrequired
{
  "partnerEmail": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/embed/tokens" \
  -H "Content-Type: application/json" \
  -d '{"partnerEmail":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/embed/tokens', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"partnerEmail":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/embed/tokens",
    headers={
    "Content-Type": "application/json",
    },
    json={"partnerEmail": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/embed/tokens", strings.NewReader(`{"partnerEmail":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/embed/tokens');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"partnerEmail":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/embed/tokens')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"partnerEmail":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/embed/tokens"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"partnerEmail\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "token": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
tokenstringrequired
expiresAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/embed/summary
GET /v1/embed/summary
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/embed/summary"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/embed/summary', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/embed/summary",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/embed/summary", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/embed/summary');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/embed/summary')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/embed/summary"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "partner": {
    "name": "string",
    "email": "string"
  },
  "clicks": 0,
  "referrals": 0,
  "balances": [
    {
      "currency": "string",
      "pending": 0,
      "approved": 0,
      "paid": 0
    }
  ],
  "links": [
    {
      "code": "string",
      "destinationUrl": "string"
    }
  ]
}
Schema
partnerobjectrequired
Show child parameters
namestringrequired
emailstringrequired
clicksintegerrequired
referralsintegerrequired
balancesobject[]required
Show child parameters
currencystringrequired
pendingintegerrequired
Integer minor units (cents).
approvedintegerrequired
Integer minor units (cents).
paidintegerrequired
Integer minor units (cents).
linksobject[]required
Show child parameters
codestringrequired
destinationUrlstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/discovery/search
POST /v1/discovery/search
Request body application/json
keywordsstring[]required
categorystring
{
  "keywords": [
    "string"
  ],
  "category": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/discovery/search" \
  -H "Content-Type: application/json" \
  -d '{"keywords":["string"],"category":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/discovery/search', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"keywords":["string"],"category":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/discovery/search",
    headers={
    "Content-Type": "application/json",
    },
    json={"keywords": ["string"], "category": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/discovery/search", strings.NewReader(`{"keywords":["string"],"category":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/discovery/search');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"keywords":["string"],"category":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/discovery/search')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"keywords":["string"],"category":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/discovery/search"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"keywords\":[\"string\"],\"category\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "found": 0,
  "added": 0
}
Schema
foundintegerrequired
addedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/discovery/corpus
Bulk-ingest prospect corpus (footprint-enriched)
Request body application/json
keywordsstring[]
= []
entriesobject[]required
Show child parameters
namestringrequired
urlstringrequired
channelstring
youtube | blog | newsletter | podcast | x = blog
audienceSizeinteger
= 0
languagestring
= en
categoriesstring[]
= []
keywordsstring[]
= []
contactEmailstring
htmlstring
evidenceSnippetstring
evidenceSourcestring
{
  "keywords": [],
  "entries": [
    {
      "name": "string",
      "url": "string",
      "channel": "blog",
      "audienceSize": 0,
      "language": "en",
      "categories": [],
      "keywords": [],
      "contactEmail": "string",
      "html": "string",
      "evidenceSnippet": "string",
      "evidenceSource": "string"
    }
  ]
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/discovery/corpus" \
  -H "Content-Type: application/json" \
  -d '{"keywords":[],"entries":[{"name":"string","url":"string","channel":"blog","audienceSize":0,"language":"en","categories":[],"keywords":[],"contactEmail":"string","html":"string","evidenceSnippet":"string","evidenceSource":"string"}]}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/discovery/corpus', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"keywords":[],"entries":[{"name":"string","url":"string","channel":"blog","audienceSize":0,"language":"en","categories":[],"keywords":[],"contactEmail":"string","html":"string","evidenceSnippet":"string","evidenceSource":"string"}]}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/discovery/corpus",
    headers={
    "Content-Type": "application/json",
    },
    json={"keywords": [], "entries": [{"name": "string", "url": "string", "channel": "blog", "audienceSize": 0, "language": "en", "categories": [], "keywords": [], "contactEmail": "string", "html": "string", "evidenceSnippet": "string", "evidenceSource": "string"}]},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/discovery/corpus", strings.NewReader(`{"keywords":[],"entries":[{"name":"string","url":"string","channel":"blog","audienceSize":0,"language":"en","categories":[],"keywords":[],"contactEmail":"string","html":"string","evidenceSnippet":"string","evidenceSource":"string"}]}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/discovery/corpus');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"keywords":[],"entries":[{"name":"string","url":"string","channel":"blog","audienceSize":0,"language":"en","categories":[],"keywords":[],"contactEmail":"string","html":"string","evidenceSnippet":"string","evidenceSource":"string"}]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/discovery/corpus')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"keywords":[],"entries":[{"name":"string","url":"string","channel":"blog","audienceSize":0,"language":"en","categories":[],"keywords":[],"contactEmail":"string","html":"string","evidenceSnippet":"string","evidenceSource":"string"}]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/discovery/corpus"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"keywords\":[],\"entries\":[{\"name\":\"string\",\"url\":\"string\",\"channel\":\"blog\",\"audienceSize\":0,\"language\":\"en\",\"categories\":[],\"keywords\":[],\"contactEmail\":\"string\",\"html\":\"string\",\"evidenceSnippet\":\"string\",\"evidenceSource\":\"string\"}]}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "received": 0,
  "added": 0
}
Schema
receivedintegerrequired
addedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/prospects
GET /v1/prospects
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/prospects"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/prospects', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/prospects",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/prospects", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/prospects');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/prospects')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/prospects"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "url": "string",
      "channel": "string",
      "audienceSize": 0,
      "evidence": {},
      "fitScore": 0,
      "contactEmail": "string",
      "status": "string"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
namestringrequired
urlstringrequired
channelstringrequired
audienceSizeintegerrequired
evidenceGetOpenapiJsonResponserequired
fitScorenumberrequired
contactEmailstringrequired
statusstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/outreach/draft
POST /v1/outreach/draft
Request body application/json
prospectIdstringrequired
programNamestring
= our partner program
{
  "prospectId": "string",
  "programName": "our partner program"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/outreach/draft" \
  -H "Content-Type: application/json" \
  -d '{"prospectId":"string","programName":"our partner program"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/outreach/draft', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"prospectId":"string","programName":"our partner program"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/outreach/draft",
    headers={
    "Content-Type": "application/json",
    },
    json={"prospectId": "string", "programName": "our partner program"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/outreach/draft", strings.NewReader(`{"prospectId":"string","programName":"our partner program"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/outreach/draft');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"prospectId":"string","programName":"our partner program"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/outreach/draft')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"prospectId":"string","programName":"our partner program"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/outreach/draft"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"prospectId\":\"string\",\"programName\":\"our partner program\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "messageIds": [
    "string"
  ]
}
Schema
messageIdsstring[]required
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/outreach
GET /v1/outreach
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/outreach"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/outreach', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/outreach",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/outreach", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/outreach');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/outreach')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/outreach"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "prospectId": "string",
      "step": 0,
      "subject": "string",
      "status": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "sentAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
prospectIdstringrequired
stepintegerrequired
subjectstringrequired
statusstringrequired
createdAtstringrequired
sentAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve
POST /v1/outreach/{id}/approve
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/outreach/{id}/approve"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/outreach/send-due
POST /v1/outreach/send-due
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/outreach/send-due"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/outreach/send-due', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/outreach/send-due",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/outreach/send-due", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/outreach/send-due');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/outreach/send-due')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/outreach/send-due"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "sent": 0,
  "suppressed": 0,
  "capped": true,
  "failed": 0
}
Schema
sentintegerrequired
suppressedintegerrequired
cappedbooleanrequired
failedintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}
POST /v1/unsubscribe/{token}
Parameters
tokenstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/unsubscribe/{token}"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/assistant/suggestions
GET /v1/assistant/suggestions
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/assistant/suggestions"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "kind": "string",
      "message": "string",
      "suggestedAction": "string",
      "data": {}
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
kindstringrequired
messagestringrequired
suggestedActionstringrequired
dataobjectrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/marketplace/listing
GET /v1/marketplace/listing
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/marketplace/listing"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/marketplace/listing', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/marketplace/listing",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/marketplace/listing", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/marketplace/listing');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/marketplace/listing')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/marketplace/listing"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "programId": "string",
      "visibility": "string",
      "category": "string",
      "headline": "string",
      "stats": {
        "clicks": 0,
        "referrals": 0,
        "epcMinor": 0,
        "conversionRate": 0,
        "payoutReliability": null,
        "approvalLatencyHours": null
      }
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
programIdstringrequired
visibilitystringrequired
categorystringrequired
headlinestringrequired
statsobjectrequired
Show child parameters
clicksintegerrequired
referralsintegerrequired
epcMinorintegerrequired
Integer minor units (cents).
conversionRatenumberrequired
payoutReliabilitynumberrequired
approvalLatencyHoursnumberrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/marketplace/listing
PUT /v1/marketplace/listing
Request body application/json
programIdstringrequired
visibilitystring
public | unlisted = public
categorystring
= saas
headlinestring
descriptionstring
sponsoredboolean
= false
{
  "programId": "string",
  "visibility": "public",
  "category": "saas",
  "headline": "",
  "description": "",
  "sponsored": false
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/marketplace/listing" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","visibility":"public","category":"saas","headline":"","description":"","sponsored":false}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/marketplace/listing', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","visibility":"public","category":"saas","headline":"","description":"","sponsored":false}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/marketplace/listing",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "visibility": "public", "category": "saas", "headline": "", "description": "", "sponsored": False},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/marketplace/listing", strings.NewReader(`{"programId":"string","visibility":"public","category":"saas","headline":"","description":"","sponsored":false}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/marketplace/listing');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","visibility":"public","category":"saas","headline":"","description":"","sponsored":false}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/marketplace/listing')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","visibility":"public","category":"saas","headline":"","description":"","sponsored":false}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/marketplace/listing"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"programId\":\"string\",\"visibility\":\"public\",\"category\":\"saas\",\"headline\":\"\",\"description\":\"\",\"sponsored\":false}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/disputes
GET /v1/disputes
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/disputes"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/disputes', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/disputes",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/disputes", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/disputes');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/disputes')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/disputes"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "partnerId": "string",
      "partnerEmail": "string",
      "referralId": "string",
      "kind": "string",
      "status": "string",
      "detail": "string",
      "resolution": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
partnerIdstringrequired
partnerEmailstringrequired
referralIdstringrequired
kindstringrequired
statusstringrequired
detailstringrequired
resolutionstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve
POST /v1/disputes/{id}/resolve
Parameters
idstringpathrequired
Request body application/json
resolutionstringrequired
{
  "resolution": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve" \
  -H "Content-Type: application/json" \
  -d '{"resolution":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"resolution":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve",
    headers={
    "Content-Type": "application/json",
    },
    json={"resolution": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve", strings.NewReader(`{"resolution":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"resolution":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"resolution":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/disputes/{id}/resolve"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"resolution\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/creators
GET /v1/creators
Parameters
qstringquery
categorystringquery
channelstringquery
minAudienceintegerquery
minEngagementBpsintegerquery
audienceCountrystringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/creators?q=&category=&channel=&minAudience=&minEngagementBps=&audienceCountry="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "accountId": "string",
      "name": "string",
      "email": "string",
      "published": true,
      "headline": "string",
      "bio": "string",
      "categories": [
        "string"
      ],
      "languages": [
        "string"
      ],
      "country": "string",
      "channels": [
        {}
      ],
      "website": "string",
      "minAudience": 0,
      "acceptsInvites": true,
      "audience": {},
      "engagementBps": 0,
      "stats": {
        "programs": 0,
        "clicks": 0,
        "referrals": 0,
        "repeatPayerRate": null
      },
      "invited": true
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataCreatorProfile[]required
Show child parameters
accountIdstringrequired
namestringrequired
emailstring
Only on your own profile.
publishedbooleanrequired
headlinestringrequired
biostringrequired
categoriesstring[]required
languagesstring[]required
countrystringrequired
channelsGetOpenapiJsonResponse[]required
websitestringrequired
minAudienceintegerrequired
acceptsInvitesbooleanrequired
audienceobjectrequired
engagementBpsintegerrequired
statsobjectrequired
Show child parameters
programsintegerrequired
clicksintegerrequired
referralsintegerrequired
repeatPayerRatenumberrequired
invitedboolean
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/creators/{accountId}
GET /v1/creators/{accountId}
Parameters
accountIdstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "accountId": "string",
  "name": "string",
  "email": "string",
  "published": true,
  "headline": "string",
  "bio": "string",
  "categories": [
    "string"
  ],
  "languages": [
    "string"
  ],
  "country": "string",
  "channels": [
    {}
  ],
  "website": "string",
  "minAudience": 0,
  "acceptsInvites": true,
  "audience": {},
  "engagementBps": 0,
  "stats": {
    "programs": 0,
    "clicks": 0,
    "referrals": 0,
    "repeatPayerRate": 0
  },
  "invited": true
}
Schema
accountIdstringrequired
namestringrequired
emailstring
Only on your own profile.
publishedbooleanrequired
headlinestringrequired
biostringrequired
categoriesstring[]required
languagesstring[]required
countrystringrequired
channelsGetOpenapiJsonResponse[]required
websitestringrequired
minAudienceintegerrequired
acceptsInvitesbooleanrequired
audienceobjectrequired
engagementBpsintegerrequired
statsobjectrequired
Show child parameters
programsintegerrequired
clicksintegerrequired
referralsintegerrequired
repeatPayerRatenumberrequired
invitedboolean
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite
POST /v1/creators/{accountId}/invite
Parameters
accountIdstringpathrequired
Request body application/json
programIdstringrequired
messagestring
{
  "programId": "string",
  "message": ""
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","message":""}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","message":""}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "message": ""},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite", strings.NewReader(`{"programId":"string","message":""}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","message":""}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","message":""}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/creators/{accountId}/invite"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"programId\":\"string\",\"message\":\"\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "program": "string"
}
Schema
idstringrequired
programstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw
POST /v1/invitations/{id}/withdraw
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/invitations/{id}/withdraw"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "status": "string"
}
Schema
okbooleanrequired
statusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/invitations
GET /v1/invitations
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/invitations"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/invitations', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/invitations",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/invitations", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/invitations');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/invitations')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/invitations"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "creatorName": "string",
      "accountId": "string",
      "programId": "string",
      "programName": "string",
      "status": "string",
      "message": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "respondedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
creatorNamestringrequired
accountIdstringrequired
programIdstringrequired
programNamestringrequired
statusstringrequired
messagestringrequired
createdAtstringrequired
respondedAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/rewards
GET /v1/rewards
Parameters
statusstringquery
issued | redeemed | void
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/rewards?status="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/rewards?status=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/rewards?status=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/rewards?status=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/rewards?status=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/rewards?status=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/rewards?status="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "referralId": "string",
      "customerRef": "string",
      "kind": "string",
      "amountMinor": 0,
      "currency": "string",
      "code": "string",
      "status": "issued",
      "createdAt": "2024-01-01T00:00:00Z",
      "redeemedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
programIdstringrequired
referralIdstringrequired
customerRefstringrequired
kindstringrequired
amountMinorintegerrequired
Integer minor units (cents).
currencystringrequired
codestringrequired
statusstringrequired
issued | redeemed | void
createdAtstringrequired
redeemedAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}
GET /v1/rewards/lookup/{code}
Parameters
codestringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/rewards/lookup/{code}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "valid": true,
  "rewardId": "string",
  "kind": "string",
  "amountMinor": 0,
  "currency": "string",
  "status": "string"
}
Schema
validbooleanrequired
rewardIdstring
kindstring
amountMinorinteger
Integer minor units (cents).
currencystring
statusstring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem
POST /v1/rewards/{id}/redeem
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/rewards/{id}/redeem"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "status": "string"
}
Schema
okbooleanrequired
statusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PATCHhttps://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}
PATCH /v1/partner-groups/{id}
Parameters
idstringpathrequired
Request body application/json
namestring
baseobject
holdDaysinteger
minThresholdMinorinteger
payoutCurrencystring
onboardingMessagestring
onboardingCheckliststring[]
archivedboolean
{
  "name": "string",
  "base": {
    "kind": "string",
    "bps": 0
  },
  "holdDays": 0,
  "minThresholdMinor": 0,
  "payoutCurrency": "string",
  "onboardingMessage": "string",
  "onboardingChecklist": [
    "string"
  ],
  "archived": true
}
Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"],"archived":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"],"archived":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PATCH",
    "https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}",
    headers={
    "Content-Type": "application/json",
    },
    json={"name": "string", "base": {"kind": "string", "bps": 0}, "holdDays": 0, "minThresholdMinor": 0, "payoutCurrency": "string", "onboardingMessage": "string", "onboardingChecklist": ["string"], "archived": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}", strings.NewReader(`{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"],"archived":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"],"archived":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"],"archived":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partner-groups/{id}"))
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"name\":\"string\",\"base\":{\"kind\":\"string\",\"bps\":0},\"holdDays\":0,\"minThresholdMinor\":0,\"payoutCurrency\":\"string\",\"onboardingMessage\":\"string\",\"onboardingChecklist\":[\"string\"],\"archived\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "programId": "string",
  "name": "string",
  "base": {
    "kind": "string",
    "bps": 0
  },
  "holdDays": 0,
  "minThresholdMinor": 0,
  "payoutCurrency": "string",
  "onboardingMessage": "string",
  "onboardingChecklist": [
    "string"
  ],
  "members": 0,
  "archivedAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
programIdstringrequired
namestringrequired
baseobjectrequired
holdDaysintegerrequired
minThresholdMinorintegerrequired
payoutCurrencystringrequired
onboardingMessagestringrequired
onboardingCheckliststring[]required
membersinteger
archivedAtstringrequired
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end
POST /v1/promotions/{id}/end
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/promotions/{id}/end"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "programId": "string",
  "name": "string",
  "groupId": "string",
  "effect": {
    "kind": "string",
    "base": {
      "kind": null,
      "bps": null
    }
  },
  "startsAt": "2024-01-01T00:00:00Z",
  "endsAt": "2024-01-01T00:00:00Z",
  "endedAt": "2024-01-01T00:00:00Z",
  "status": "scheduled",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
programIdstringrequired
namestringrequired
groupIdstringrequired
effectobjectrequired
startsAtstringrequired
endsAtstringrequired
endedAtstringrequired
statusstringrequired
scheduled | active | ended
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/contracts
GET /v1/contracts
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/contracts"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/contracts', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/contracts",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/contracts", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/contracts');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/contracts')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/contracts"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "partnerId": "string",
      "title": "string",
      "compensation": {},
      "status": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "respondedAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
programIdstringrequired
partnerIdstringrequired
titlestringrequired
compensationobjectrequired
statusstringrequired
createdAtstringrequired
respondedAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/contracts
POST /v1/contracts
Request body application/json
programIdstringrequired
partnerIdstringrequired
titlestring
termsMdstring
compensationobjectrequired
sendboolean
= false
{
  "programId": "string",
  "partnerId": "string",
  "title": "",
  "termsMd": "",
  "compensation": {
    "kind": "string",
    "bps": 0
  },
  "send": false
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/contracts" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","partnerId":"string","title":"","termsMd":"","compensation":{"kind":"string","bps":0},"send":false}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/contracts', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","partnerId":"string","title":"","termsMd":"","compensation":{"kind":"string","bps":0},"send":false}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/contracts",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "partnerId": "string", "title": "", "termsMd": "", "compensation": {"kind": "string", "bps": 0}, "send": False},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/contracts", strings.NewReader(`{"programId":"string","partnerId":"string","title":"","termsMd":"","compensation":{"kind":"string","bps":0},"send":false}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/contracts');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","partnerId":"string","title":"","termsMd":"","compensation":{"kind":"string","bps":0},"send":false}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/contracts')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","partnerId":"string","title":"","termsMd":"","compensation":{"kind":"string","bps":0},"send":false}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/contracts"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"programId\":\"string\",\"partnerId\":\"string\",\"title\":\"\",\"termsMd\":\"\",\"compensation\":{\"kind\":\"string\",\"bps\":0},\"send\":false}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "status": "draft"
}
Schema
idstringrequired
statusstringrequired
draft | sent
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send
POST /v1/contracts/{id}/send
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/contracts/{id}/send"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "status": "string"
}
Schema
okbooleanrequired
statusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/incrementality
GET /v1/incrementality
Parameters
programIdstringqueryrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/incrementality?programId="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/incrementality?programId=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/incrementality?programId=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/incrementality?programId=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/incrementality?programId=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/incrementality?programId=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/incrementality?programId="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "programId": "string",
  "holdoutBps": 0,
  "treatment": {
    "referrals": 0,
    "converted": 0,
    "rate": 0
  },
  "control": {
    "referrals": 0,
    "converted": 0,
    "rate": 0
  },
  "lift": 0,
  "byPartner": [
    {
      "partnerId": "string",
      "treatmentReferrals": 0,
      "controlReferrals": 0,
      "lift": 0
    }
  ]
}
Schema
programIdstringrequired
holdoutBpsintegerrequired
treatmentobjectrequired
Show child parameters
referralsintegerrequired
convertedintegerrequired
ratenumberrequired
controlobjectrequired
Show child parameters
referralsintegerrequired
convertedintegerrequired
ratenumberrequired
liftnumberrequired
byPartnerobject[]required
Show child parameters
partnerIdstringrequired
treatmentReferralsintegerrequired
controlReferralsintegerrequired
liftnumberrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/passport/public-key
GET /v1/passport/public-key
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/passport/public-key"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/passport/public-key', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/passport/public-key",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/passport/public-key", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/passport/public-key');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/passport/public-key')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/passport/public-key"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "algorithm": "string",
  "publicKey": "string"
}
Schema
algorithmstringrequired
publicKeystringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/passport/verify
POST /v1/passport/verify
Request body application/json
passportrequired
{
  "passport": {}
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/passport/verify" \
  -H "Content-Type: application/json" \
  -d '{"passport":{}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/passport/verify', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"passport":{}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/passport/verify",
    headers={
    "Content-Type": "application/json",
    },
    json={"passport": {}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/passport/verify", strings.NewReader(`{"passport":{}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/passport/verify');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"passport":{}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/passport/verify')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"passport":{}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/passport/verify"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"passport\":{}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "valid": true,
  "claims": {},
  "reason": "string"
}
Schema
validbooleanrequired
claimsobject
reasonstring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/network/settings
GET /v1/network/settings
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/network/settings"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/network/settings', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/network/settings",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/network/settings", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/network/settings');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/network/settings')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/network/settings"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "enabled": true
}
Schema
enabledbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/network/settings
PUT /v1/network/settings
Request body application/json
enabledbooleanrequired
{
  "enabled": true
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/network/settings" \
  -H "Content-Type: application/json" \
  -d '{"enabled":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/network/settings', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"enabled":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/network/settings",
    headers={
    "Content-Type": "application/json",
    },
    json={"enabled": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/network/settings", strings.NewReader(`{"enabled":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/network/settings');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"enabled":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/network/settings')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"enabled":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/network/settings"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"enabled\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "enabled": true
}
Schema
enabledbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/network/journey
GET /v1/network/journey
Parameters
emailHashstringqueryrequired
modelstringquery
linear | first | last | time_decay = linear
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/network/journey?emailHash=&model="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "emailHash": "string",
  "model": "string",
  "touchpoints": [
    {
      "partnerAccountId": "string",
      "ts": "2024-01-01T00:00:00Z",
      "credit": 0
    }
  ],
  "partners": 0
}
Schema
emailHashstringrequired
modelstringrequired
touchpointsobject[]required
Show child parameters
partnerAccountIdstringrequired
tsstringrequired
creditnumberrequired
partnersintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/negotiations
GET /v1/negotiations
Parameters
programIdstringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/negotiations?programId="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/negotiations?programId=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/negotiations?programId=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/negotiations?programId=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/negotiations?programId=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/negotiations?programId=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/negotiations?programId="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "agentAccountId": "string",
      "proposedBps": 0,
      "decision": "string",
      "rateBps": 0,
      "round": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
programIdstringrequired
agentAccountIdstringrequired
proposedBpsintegerrequired
decisionstringrequired
rateBpsintegerrequired
roundintegerrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/cleanroom/consent
GET /v1/cleanroom/consent
Parameters
customerRefstringqueryrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cleanroom/consent?customerRef="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "customerRef": "string",
  "consent": {
    "granted": true,
    "purposes": [
      "string"
    ],
    "declared": {},
    "emailHash": "string",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}
Schema
customerRefstringrequired
consentobjectrequired
Show child parameters
grantedbooleanrequired
purposesstring[]required
declaredobjectrequired
emailHashstringrequired
updatedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/cleanroom/query
GET /v1/cleanroom/query
Parameters
dimensionstringqueryrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/cleanroom/query?dimension="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "dimension": "string",
  "k": 0,
  "cohorts": [
    {
      "key": "string",
      "count": 0
    }
  ],
  "suppressedCohorts": 0,
  "suppressedRows": 0
}
Schema
dimensionstringrequired
kintegerrequired
cohortsobject[]required
Show child parameters
keystringrequired
countintegerrequired
suppressedCohortsintegerrequired
suppressedRowsintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/agents
GET /v1/agents
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/agents"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/agents', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/agents",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/agents", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/agents');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/agents')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/agents"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "partnerId": "string",
      "accountId": "string",
      "name": "string",
      "wallet": "string",
      "metadata": {},
      "instantPayout": true,
      "status": "string",
      "recommendations": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
partnerIdstringrequired
accountIdstringrequired
namestringrequired
walletstringrequired
metadataGetOpenapiJsonResponserequired
instantPayoutbooleanrequired
statusstringrequired
recommendationsintegerrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/agents/recommendations
GET /v1/agents/recommendations
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/agents/recommendations"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/agents/recommendations', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/agents/recommendations",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/agents/recommendations", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/agents/recommendations');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/agents/recommendations')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/agents/recommendations"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "customerRef": "string",
      "agent": "string",
      "wallet": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
programIdstringrequired
customerRefstringrequired
agentstringrequired
walletstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/admin/metrics
GET /v1/admin/metrics
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/admin/metrics"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/metrics', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/admin/metrics",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/admin/metrics", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/metrics');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/metrics')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/metrics"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "orgs": 0,
  "suspendedOrgs": 0,
  "partnerAccounts": 0,
  "bannedPartners": 0,
  "programs": 0,
  "commissionEarnedMinor": 0,
  "payoutsSent": 0,
  "openFraudCases": 0
}
Schema
orgsintegerrequired
suspendedOrgsintegerrequired
partnerAccountsintegerrequired
bannedPartnersintegerrequired
programsintegerrequired
commissionEarnedMinorintegerrequired
Integer minor units (cents).
payoutsSentintegerrequired
openFraudCasesintegerrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/admin/orgs
GET /v1/admin/orgs
Parameters
qstringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/orgs?q="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "name": "string",
      "plan": "string",
      "planStatus": "string",
      "suspended": true,
      "createdAt": "2024-01-01T00:00:00Z",
      "programs": 0,
      "partners": 0
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
namestringrequired
planstringrequired
planStatusstringrequired
suspendedbooleanrequired
createdAtstringrequired
programsintegerrequired
partnersintegerrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend
POST /v1/admin/orgs/{id}/suspend
Parameters
idstringpathrequired
Request body application/json
reasonstring
{
  "reason": ""
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend" \
  -H "Content-Type: application/json" \
  -d '{"reason":""}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"reason":""}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend",
    headers={
    "Content-Type": "application/json",
    },
    json={"reason": ""},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend", strings.NewReader(`{"reason":""}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"reason":""}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"reason":""}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/suspend"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"reason\":\"\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "suspended": true
}
Schema
okbooleanrequired
suspendedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan
POST /v1/admin/orgs/{id}/plan
Parameters
idstringpathrequired
Request body application/json
planstringrequired
free | growth | pro | scale | starter
{
  "plan": "free"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan" \
  -H "Content-Type: application/json" \
  -d '{"plan":"free"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"plan":"free"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan",
    headers={
    "Content-Type": "application/json",
    },
    json={"plan": "free"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan", strings.NewReader(`{"plan":"free"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"plan":"free"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"plan":"free"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/plan"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"plan\":\"free\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "plan": "string",
  "planStatus": "string"
}
Schema
planstringrequired
planStatusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend
POST /v1/admin/orgs/{id}/unsuspend
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/orgs/{id}/unsuspend"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "suspended": true
}
Schema
okbooleanrequired
suspendedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts
GET /v1/admin/partner-accounts
Parameters
flaggedbooleanquery
qstringquery
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts?flagged=&q="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "email": "string",
      "name": "string",
      "banned": true,
      "kycStatus": "string",
      "sanctionsStatus": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
emailstringrequired
namestringrequired
bannedbooleanrequired
kycStatusstringrequired
sanctionsStatusstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban
POST /v1/admin/partner-accounts/{id}/ban
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/ban"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "banned": true
}
Schema
okbooleanrequired
bannedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban
POST /v1/admin/partner-accounts/{id}/unban
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/admin/partner-accounts/{id}/unban"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "banned": true
}
Schema
okbooleanrequired
bannedbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/notifications
GET /v1/notifications
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/notifications"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/notifications', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/notifications",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/notifications", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/notifications');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/notifications')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/notifications"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "topic": "string",
      "message": "string",
      "data": {},
      "readAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataNotification[]required
Show child parameters
idstringrequired
topicstringrequired
messagestringrequired
dataGetOpenapiJsonResponserequired
readAtstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read
POST /v1/notifications/{id}/read
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/notifications/{id}/read"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/assets
GET /v1/assets
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/assets"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/assets', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/assets",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/assets", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/assets');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/assets')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/assets"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "programId": "string",
      "kind": "string",
      "title": "string",
      "content": "string",
      "dimensions": "string",
      "groupId": "string",
      "clicks": 0,
      "referrals": 0,
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataobject[]required
Show child parameters
idstringrequired
programIdstringrequired
kindstringrequired
titlestringrequired
contentstringrequired
dimensionsstringrequired
groupIdstringrequired
clicksintegerrequired
referralsintegerrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/assets
POST /v1/assets
Request body application/json
programIdstringrequired
kindstringrequired
banner | copy | video | logo
titlestringrequired
contentstring
dimensionsstring
groupIdstring
{
  "programId": "string",
  "kind": "banner",
  "title": "string",
  "content": "",
  "dimensions": "",
  "groupId": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/assets" \
  -H "Content-Type: application/json" \
  -d '{"programId":"string","kind":"banner","title":"string","content":"","dimensions":"","groupId":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/assets', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"programId":"string","kind":"banner","title":"string","content":"","dimensions":"","groupId":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/assets",
    headers={
    "Content-Type": "application/json",
    },
    json={"programId": "string", "kind": "banner", "title": "string", "content": "", "dimensions": "", "groupId": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/assets", strings.NewReader(`{"programId":"string","kind":"banner","title":"string","content":"","dimensions":"","groupId":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/assets');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"programId":"string","kind":"banner","title":"string","content":"","dimensions":"","groupId":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/assets')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"programId":"string","kind":"banner","title":"string","content":"","dimensions":"","groupId":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/assets"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"programId\":\"string\",\"kind\":\"banner\",\"title\":\"string\",\"content\":\"\",\"dimensions\":\"\",\"groupId\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "programId": "string",
  "kind": "string",
  "title": "string",
  "content": "string",
  "dimensions": "string",
  "groupId": "string"
}
Schema
idstringrequired
programIdstringrequired
kindstringrequired
titlestringrequired
contentstringrequired
dimensionsstringrequired
groupIdstring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/assets/{id}
DELETE /v1/assets/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/assets/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/assets/{id}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/assets/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/assets/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/assets/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/assets/{id}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/assets/{id}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/setup/status
Install checker with next-step hints
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/setup/status"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/setup/status', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/setup/status",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/setup/status", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/setup/status');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/setup/status')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/setup/status"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "checks": {},
  "hints": [
    "string"
  ],
  "hintKeys": [
    "string"
  ],
  "progress": "string"
}
Schema
checksobjectrequired
hintsstring[]required
hintKeysstring[]required
Stable keys for each hint, in the same order, for localized clients.
progressstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/anomalies/scan
Spike/drop anomaly scan
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/anomalies/scan"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/anomalies/scan', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/anomalies/scan",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/anomalies/scan", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/anomalies/scan');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/anomalies/scan')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/anomalies/scan"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
[
  {
    "orgId": "string",
    "metric": "clicks",
    "kind": "spike",
    "last24h": 0,
    "daily7dAvg": 0
  }
]
Schema
orgIdstringrequired
metricstringrequired
clicks | referrals | refunds
kindstringrequired
spike | drop
last24hnumberrequired
daily7dAvgnumberrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/email/settings
GET /v1/email/settings
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/email/settings"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/settings', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/email/settings",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/email/settings", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/settings');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/settings')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/settings"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "provider": "resend",
  "hasApiKey": true,
  "fromAddress": "string",
  "fromName": "string",
  "replyTo": "string",
  "defaultLocale": "string",
  "logoUrl": "string",
  "primaryColor": "string",
  "domainStatus": "unknown",
  "domainCheckedAt": "2024-01-01T00:00:00Z"
}
Schema
providerstringrequired
hasApiKeybooleanrequired
The key itself is write-only and never returned.
fromAddressstringrequired
fromNamestringrequired
replyTostringrequired
defaultLocalestringrequired
logoUrlstringrequired
primaryColorstringrequired
domainStatusstringrequired
unknown | pending | verified | failed
domainCheckedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/email/settings
PUT /v1/email/settings
Request body application/json
providerstring
apiKeystring
fromAddressstring
fromNamestring
replyTostring
defaultLocalestring
en | es | de | fr | pt | it | nl | sv | ja | zh
logoUrlstring
primaryColorstring
{
  "provider": "resend",
  "apiKey": "string",
  "fromAddress": "string",
  "fromName": "string",
  "replyTo": "string",
  "defaultLocale": "en",
  "logoUrl": "string",
  "primaryColor": "string"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/email/settings" \
  -H "Content-Type: application/json" \
  -d '{"provider":"resend","apiKey":"string","fromAddress":"string","fromName":"string","replyTo":"string","defaultLocale":"en","logoUrl":"string","primaryColor":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/settings', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"provider":"resend","apiKey":"string","fromAddress":"string","fromName":"string","replyTo":"string","defaultLocale":"en","logoUrl":"string","primaryColor":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/email/settings",
    headers={
    "Content-Type": "application/json",
    },
    json={"provider": "resend", "apiKey": "string", "fromAddress": "string", "fromName": "string", "replyTo": "string", "defaultLocale": "en", "logoUrl": "string", "primaryColor": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/email/settings", strings.NewReader(`{"provider":"resend","apiKey":"string","fromAddress":"string","fromName":"string","replyTo":"string","defaultLocale":"en","logoUrl":"string","primaryColor":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/settings');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"provider":"resend","apiKey":"string","fromAddress":"string","fromName":"string","replyTo":"string","defaultLocale":"en","logoUrl":"string","primaryColor":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/settings')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"provider":"resend","apiKey":"string","fromAddress":"string","fromName":"string","replyTo":"string","defaultLocale":"en","logoUrl":"string","primaryColor":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/settings"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"provider\":\"resend\",\"apiKey\":\"string\",\"fromAddress\":\"string\",\"fromName\":\"string\",\"replyTo\":\"string\",\"defaultLocale\":\"en\",\"logoUrl\":\"string\",\"primaryColor\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "provider": "resend",
  "hasApiKey": true,
  "fromAddress": "string",
  "fromName": "string",
  "replyTo": "string",
  "defaultLocale": "string",
  "logoUrl": "string",
  "primaryColor": "string",
  "domainStatus": "unknown",
  "domainCheckedAt": "2024-01-01T00:00:00Z"
}
Schema
providerstringrequired
hasApiKeybooleanrequired
The key itself is write-only and never returned.
fromAddressstringrequired
fromNamestringrequired
replyTostringrequired
defaultLocalestringrequired
logoUrlstringrequired
primaryColorstringrequired
domainStatusstringrequired
unknown | pending | verified | failed
domainCheckedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain
POST /v1/email/settings/verify-domain
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/settings/verify-domain"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "provider": "resend",
  "hasApiKey": true,
  "fromAddress": "string",
  "fromName": "string",
  "replyTo": "string",
  "defaultLocale": "string",
  "logoUrl": "string",
  "primaryColor": "string",
  "domainStatus": "unknown",
  "domainCheckedAt": "2024-01-01T00:00:00Z",
  "domain": "string"
}
Schema
providerstringrequired
hasApiKeybooleanrequired
The key itself is write-only and never returned.
fromAddressstringrequired
fromNamestringrequired
replyTostringrequired
defaultLocalestringrequired
logoUrlstringrequired
primaryColorstringrequired
domainStatusstringrequired
unknown | pending | verified | failed
domainCheckedAtstringrequired
domainstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/email/templates
GET /v1/email/templates
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/email/templates"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/templates', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/email/templates",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/email/templates", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/templates');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/templates')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/templates"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "event": "string",
      "audience": "partner",
      "placeholders": [
        "string"
      ],
      "locales": [
        {
          "locale": null,
          "default": null,
          "override": null
        }
      ]
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataEmailTemplateEvent[]required
Show child parameters
eventstringrequired
audiencestringrequired
partner | merchant
placeholdersstring[]required
localesobject[]required
Show child parameters
localestringrequired
defaultobjectrequired
overrideobjectrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}
PUT /v1/email/templates/{event}/{locale}
Parameters
eventstringpathrequired
localestringpathrequired
Request body application/json
subjectstringrequired
textstringrequired
htmlstring
{
  "subject": "string",
  "text": "string",
  "html": "string"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","text":"string","html":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"subject":"string","text":"string","html":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}",
    headers={
    "Content-Type": "application/json",
    },
    json={"subject": "string", "text": "string", "html": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}", strings.NewReader(`{"subject":"string","text":"string","html":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"subject":"string","text":"string","html":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"subject":"string","text":"string","html":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"subject\":\"string\",\"text\":\"string\",\"html\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "event": "string",
  "locale": "string",
  "subject": "string",
  "text": "string",
  "html": "string",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
eventstringrequired
localestringrequired
subjectstringrequired
textstringrequired
htmlstringrequired
updatedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}
DELETE /v1/email/templates/{event}/{locale}
Parameters
eventstringpathrequired
localestringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/templates/{event}/{locale}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "reset": true
}
Schema
okbooleanrequired
resetbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/email/preview
POST /v1/email/preview
Request body application/json
eventstringrequired
payout_sent | payout_failed | invitation_received | partner_approved | contract_sent | webhook_endpoint_disabled | tax_document_ready
localestringrequired
en | es | de | fr | pt | it | nl | sv | ja | zh
draftobject
Show child parameters
subjectstringrequired
textstringrequired
htmlstring
{
  "event": "payout_sent",
  "locale": "en",
  "draft": {
    "subject": "string",
    "text": "string",
    "html": "string"
  }
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/email/preview" \
  -H "Content-Type: application/json" \
  -d '{"event":"payout_sent","locale":"en","draft":{"subject":"string","text":"string","html":"string"}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/preview', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"event":"payout_sent","locale":"en","draft":{"subject":"string","text":"string","html":"string"}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/email/preview",
    headers={
    "Content-Type": "application/json",
    },
    json={"event": "payout_sent", "locale": "en", "draft": {"subject": "string", "text": "string", "html": "string"}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/email/preview", strings.NewReader(`{"event":"payout_sent","locale":"en","draft":{"subject":"string","text":"string","html":"string"}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/preview');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"event":"payout_sent","locale":"en","draft":{"subject":"string","text":"string","html":"string"}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/preview')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"event":"payout_sent","locale":"en","draft":{"subject":"string","text":"string","html":"string"}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/preview"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"event\":\"payout_sent\",\"locale\":\"en\",\"draft\":{\"subject\":\"string\",\"text\":\"string\",\"html\":\"string\"}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "locale": "string",
  "subject": "string",
  "text": "string",
  "html": "string",
  "source": "override"
}
Schema
localestringrequired
subjectstringrequired
textstringrequired
htmlstringrequired
sourcestringrequired
override | default
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/email/test
POST /v1/email/test
Request body application/json
eventstringrequired
payout_sent | payout_failed | invitation_received | partner_approved | contract_sent | webhook_endpoint_disabled | tax_document_ready
localestringrequired
en | es | de | fr | pt | it | nl | sv | ja | zh
tostringrequired
{
  "event": "payout_sent",
  "locale": "en",
  "to": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/email/test" \
  -H "Content-Type: application/json" \
  -d '{"event":"payout_sent","locale":"en","to":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/email/test', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"event":"payout_sent","locale":"en","to":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/email/test",
    headers={
    "Content-Type": "application/json",
    },
    json={"event": "payout_sent", "locale": "en", "to": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/email/test", strings.NewReader(`{"event":"payout_sent","locale":"en","to":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/email/test');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"event":"payout_sent","locale":"en","to":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/email/test')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"event":"payout_sent","locale":"en","to":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/email/test"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"event\":\"payout_sent\",\"locale\":\"en\",\"to\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "sent": true,
  "id": "string",
  "provider": "string"
}
Schema
sentbooleanrequired
idstringrequired
providerstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/me/locale
PUT /v1/me/locale
Request body application/json
localestringrequired
en | es | de | fr | pt | it | nl | sv | ja | zh
{
  "locale": "en"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/me/locale" \
  -H "Content-Type: application/json" \
  -d '{"locale":"en"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/me/locale', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"locale":"en"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/me/locale",
    headers={
    "Content-Type": "application/json",
    },
    json={"locale": "en"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/me/locale", strings.NewReader(`{"locale":"en"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/me/locale');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"locale":"en"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/me/locale')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"locale":"en"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/me/locale"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"locale\":\"en\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "locale": "string"
}
Schema
localestringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/integrations
GET /v1/integrations
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/integrations"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/integrations",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/integrations", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "zapier": {
    "hooks": 0,
    "events": [
      "string"
    ]
  },
  "hubspot": {
    "id": "string",
    "kind": "hubspot",
    "status": "active",
    "config": {},
    "hasCredential": true,
    "lastError": "string",
    "lastSuccessAt": "2024-01-01T00:00:00Z",
    "pausedUntil": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  },
  "segment": {
    "id": "string",
    "kind": "hubspot",
    "status": "active",
    "config": {},
    "hasCredential": true,
    "lastError": "string",
    "lastSuccessAt": "2024-01-01T00:00:00Z",
    "pausedUntil": "2024-01-01T00:00:00Z",
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-01-01T00:00:00Z"
  }
}
Schema
zapierobjectrequired
Show child parameters
hooksintegerrequired
eventsstring[]required
hubspotIntegrationConnectionrequired
Show child parameters
idstringrequired
kindstringrequired
hubspot | segment
statusstringrequired
active | paused | error
configobjectrequired
hasCredentialbooleanrequired
lastErrorstringrequired
lastSuccessAtstringrequired
pausedUntilstringrequired
createdAtstringrequired
updatedAtstringrequired
segmentIntegrationConnectionrequired
Show child parameters
idstringrequired
kindstringrequired
hubspot | segment
statusstringrequired
active | paused | error
configobjectrequired
hasCredentialbooleanrequired
lastErrorstringrequired
lastSuccessAtstringrequired
pausedUntilstringrequired
createdAtstringrequired
updatedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/integrations/hubspot
PUT /v1/integrations/hubspot
Request body application/json
tokenstring
pipelinestring
newDealStagestring
paidDealStagestring
statusstring
active | paused
{
  "token": "string",
  "pipeline": "string",
  "newDealStage": "string",
  "paidDealStage": "string",
  "status": "active"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot" \
  -H "Content-Type: application/json" \
  -d '{"token":"string","pipeline":"string","newDealStage":"string","paidDealStage":"string","status":"active"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"token":"string","pipeline":"string","newDealStage":"string","paidDealStage":"string","status":"active"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot",
    headers={
    "Content-Type": "application/json",
    },
    json={"token": "string", "pipeline": "string", "newDealStage": "string", "paidDealStage": "string", "status": "active"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot", strings.NewReader(`{"token":"string","pipeline":"string","newDealStage":"string","paidDealStage":"string","status":"active"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"token":"string","pipeline":"string","newDealStage":"string","paidDealStage":"string","status":"active"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"token":"string","pipeline":"string","newDealStage":"string","paidDealStage":"string","status":"active"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"token\":\"string\",\"pipeline\":\"string\",\"newDealStage\":\"string\",\"paidDealStage\":\"string\",\"status\":\"active\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "kind": "hubspot",
  "status": "active",
  "config": {},
  "hasCredential": true,
  "lastError": "string",
  "lastSuccessAt": "2024-01-01T00:00:00Z",
  "pausedUntil": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
hubspot | segment
statusstringrequired
active | paused | error
configobjectrequired
hasCredentialbooleanrequired
lastErrorstringrequired
lastSuccessAtstringrequired
pausedUntilstringrequired
createdAtstringrequired
updatedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PUThttps://referally.15.204.158.166.sslip.io/v1/integrations/segment
PUT /v1/integrations/segment
Request body application/json
writeKeystring
eventsstring[]
statusstring
active | paused
{
  "writeKey": "string",
  "events": [
    "referral.created"
  ],
  "status": "active"
}
Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/integrations/segment" \
  -H "Content-Type: application/json" \
  -d '{"writeKey":"string","events":["referral.created"],"status":"active"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/segment', {
  method: 'PUT',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"writeKey":"string","events":["referral.created"],"status":"active"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PUT",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/segment",
    headers={
    "Content-Type": "application/json",
    },
    json={"writeKey": "string", "events": ["referral.created"], "status": "active"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/integrations/segment", strings.NewReader(`{"writeKey":"string","events":["referral.created"],"status":"active"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/segment');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"writeKey":"string","events":["referral.created"],"status":"active"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/segment')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"writeKey":"string","events":["referral.created"],"status":"active"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/segment"))
    .header("Content-Type", "application/json")
    .method("PUT", BodyPublishers.ofString("{\"writeKey\":\"string\",\"events\":[\"referral.created\"],\"status\":\"active\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "kind": "hubspot",
  "status": "active",
  "config": {},
  "hasCredential": true,
  "lastError": "string",
  "lastSuccessAt": "2024-01-01T00:00:00Z",
  "pausedUntil": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
hubspot | segment
statusstringrequired
active | paused | error
configobjectrequired
hasCredentialbooleanrequired
lastErrorstringrequired
lastSuccessAtstringrequired
pausedUntilstringrequired
createdAtstringrequired
updatedAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/integrations/{kind}
DELETE /v1/integrations/{kind}
Parameters
kindstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/{kind}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test
POST /v1/integrations/hubspot/test
Request body application/json
setupPropertiesboolean
= true
{
  "setupProperties": true
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test" \
  -H "Content-Type: application/json" \
  -d '{"setupProperties":true}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"setupProperties":true}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test",
    headers={
    "Content-Type": "application/json",
    },
    json={"setupProperties": True},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test", strings.NewReader(`{"setupProperties":true}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"setupProperties":true}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"setupProperties":true}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/hubspot/test"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"setupProperties\":true}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "portalId": 0,
  "createdProperties": [
    "string"
  ],
  "error": "string"
}
Schema
okbooleanrequired
portalIdintegerrequired
createdPropertiesstring[]required
errorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/integrations/segment/test
POST /v1/integrations/segment/test
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/segment/test"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "error": "string"
}
Schema
okbooleanrequired
errorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/integrations/deliveries
GET /v1/integrations/deliveries
Parameters
kindstringquery
zapier | hubspot | segment
statusstringquery
pending | sent | failed | skipped
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries?kind=&status="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "kind": "zapier",
      "targetId": "string",
      "eventId": "string",
      "topic": "string",
      "status": "pending",
      "attempts": 0,
      "nextAt": "2024-01-01T00:00:00Z",
      "lastError": "string",
      "sentAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataIntegrationDelivery[]required
Show child parameters
idstringrequired
kindstringrequired
zapier | hubspot | segment
targetIdstringrequired
eventIdstringrequired
topicstringrequired
statusstringrequired
pending | sent | failed | skipped
attemptsintegerrequired
nextAtstringrequired
lastErrorstringrequired
sentAtstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry
POST /v1/integrations/deliveries/{id}/retry
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/integrations/deliveries/{id}/retry"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "kind": "zapier",
  "targetId": "string",
  "eventId": "string",
  "topic": "string",
  "status": "pending",
  "attempts": 0,
  "nextAt": "2024-01-01T00:00:00Z",
  "lastError": "string",
  "sentAt": "2024-01-01T00:00:00Z",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
kindstringrequired
zapier | hubspot | segment
targetIdstringrequired
eventIdstringrequired
topicstringrequired
statusstringrequired
pending | sent | failed | skipped
attemptsintegerrequired
nextAtstringrequired
lastErrorstringrequired
sentAtstringrequired
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/zapier/events
GET /v1/zapier/events
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/zapier/events"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/zapier/events', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/zapier/events",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/zapier/events", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/zapier/events');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/zapier/events')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/zapier/events"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
[
  {
    "key": "string"
  }
]
Schema
keystringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/zapier/hooks
GET /v1/zapier/hooks
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/zapier/hooks', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/zapier/hooks');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/zapier/hooks')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/zapier/hooks"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
  "object": "string",
  "data": [
    {
      "id": "string",
      "event": "string",
      "target_url": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataZapierHook[]required
Show child parameters
idstringrequired
eventstringrequired
target_urlstringrequired
createdAtstringrequired
has_morebooleanrequired
Whether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/zapier/hooks
POST /v1/zapier/hooks
Request body application/json
target_urlstringrequired
eventstringrequired
referral.created | commission.earned | commission.reversed | commission.settled | payout.sent | payout.failed | partner.applied | partner.enrolled | partner.approved | deal.submitted | fraud.case_opened
{
  "target_url": "string",
  "event": "referral.created"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks" \
  -H "Content-Type: application/json" \
  -d '{"target_url":"string","event":"referral.created"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/zapier/hooks', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"target_url":"string","event":"referral.created"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks",
    headers={
    "Content-Type": "application/json",
    },
    json={"target_url": "string", "event": "referral.created"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks", strings.NewReader(`{"target_url":"string","event":"referral.created"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/zapier/hooks');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"target_url":"string","event":"referral.created"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/zapier/hooks')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"target_url":"string","event":"referral.created"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/zapier/hooks"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"target_url\":\"string\",\"event\":\"referral.created\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "event": "string",
  "target_url": "string",
  "createdAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
eventstringrequired
target_urlstringrequired
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
DELETEhttps://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}
DELETE /v1/zapier/hooks/{id}
Parameters
idstringpathrequired
Code samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}', {
  method: 'DELETE',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "DELETE",
    "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/zapier/hooks/{id}"))
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true
}
Schema
okbooleanrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}
GET /v1/zapier/triggers/{event}
Parameters
eventstringpathrequired
limitintegerquery
= 25
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit=",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit=", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/zapier/triggers/{event}?limit="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
[
  {
    "id": "string",
    "event": "string",
    "createdAt": "2024-01-01T00:00:00Z"
  }
]
Schema
idstringrequired
eventstringrequired
createdAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/zapier/conversions
POST /v1/zapier/conversions
Request body application/json
providerEventIdstringrequired
typestring
invoice_paid | refund = invoice_paid
customerRefstringrequired
amountMinorintegerrequired
currencystring
= usd
invoiceRefstring
occurredAtstring
connectionIdstring
{
  "providerEventId": "string",
  "type": "invoice_paid",
  "customerRef": "string",
  "amountMinor": 0,
  "currency": "usd",
  "invoiceRef": "string",
  "occurredAt": "2024-01-01T00:00:00Z",
  "connectionId": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/zapier/conversions" \
  -H "Content-Type: application/json" \
  -d '{"providerEventId":"string","type":"invoice_paid","customerRef":"string","amountMinor":0,"currency":"usd","invoiceRef":"string","occurredAt":"2024-01-01T00:00:00Z","connectionId":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/zapier/conversions', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"providerEventId":"string","type":"invoice_paid","customerRef":"string","amountMinor":0,"currency":"usd","invoiceRef":"string","occurredAt":"2024-01-01T00:00:00Z","connectionId":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/zapier/conversions",
    headers={
    "Content-Type": "application/json",
    },
    json={"providerEventId": "string", "type": "invoice_paid", "customerRef": "string", "amountMinor": 0, "currency": "usd", "invoiceRef": "string", "occurredAt": "2024-01-01T00:00:00Z", "connectionId": "string"},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/zapier/conversions", strings.NewReader(`{"providerEventId":"string","type":"invoice_paid","customerRef":"string","amountMinor":0,"currency":"usd","invoiceRef":"string","occurredAt":"2024-01-01T00:00:00Z","connectionId":"string"}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/zapier/conversions');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"providerEventId":"string","type":"invoice_paid","customerRef":"string","amountMinor":0,"currency":"usd","invoiceRef":"string","occurredAt":"2024-01-01T00:00:00Z","connectionId":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/zapier/conversions')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"providerEventId":"string","type":"invoice_paid","customerRef":"string","amountMinor":0,"currency":"usd","invoiceRef":"string","occurredAt":"2024-01-01T00:00:00Z","connectionId":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/zapier/conversions"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"providerEventId\":\"string\",\"type\":\"invoice_paid\",\"customerRef\":\"string\",\"amountMinor\":0,\"currency\":\"usd\",\"invoiceRef\":\"string\",\"occurredAt\":\"2024-01-01T00:00:00Z\",\"connectionId\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "connectionId": "string"
}
Schema
connectionIdstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/sso
GET /v1/org/sso
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/sso"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/sso', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/sso",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/sso", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/sso');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/sso')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/sso"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "configured": true,
  "provider": {
    "name": "string",
    "label": "string"
  },
  "defaultRoleMapping": {},
  "linked": true,
  "tenantId": "string",
  "atlasOrgId": "string",
  "connections": [
    {
      "id": "string",
      "type": "string",
      "status": "string",
      "allowedDomains": [
        "string"
      ]
    }
  ],
  "domains": [
    "string"
  ],
  "requireSso": true,
  "roleMapping": {},
  "tickets": [
    {
      "id": "string",
      "status": "string",
      "expiresAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "providerError": "string",
  "atlasError": "string"
}
Schema
configuredbooleanrequired
providerobjectrequired
The deployment's SSO provider; null when SSO isn't configured.
Show child parameters
namestringrequired
labelstringrequired
defaultRoleMappingobjectrequired
The provider's role keys → Referally roles, before the org's own mapping.
linkedbooleanrequired
tenantIdstringrequired
The org's directory tenant at the provider.
atlasOrgIdstringrequired
Deprecated: tenantId, when the provider is Atlas.
connectionsobject[]required
Show child parameters
idstringrequired
typestringrequired
statusstringrequired
allowedDomainsstring[]required
domainsstring[]required
requireSsobooleanrequired
roleMappingobjectrequired
ticketsobject[]required
Show child parameters
idstringrequired
statusstringrequired
expiresAtstringrequired
createdAtstringrequired
providerErrorstringrequired
Why the provider couldn't be read just now, if it couldn't.
atlasErrorstringrequired
Deprecated: providerError.
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
PATCHhttps://referally.15.204.158.166.sslip.io/v1/org/sso
PATCH /v1/org/sso
Request body application/json
requireSsoboolean
roleMappingobject
{
  "requireSso": true,
  "roleMapping": {}
}
Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/org/sso" \
  -H "Content-Type: application/json" \
  -d '{"requireSso":true,"roleMapping":{}}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/sso', {
  method: 'PATCH',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"requireSso":true,"roleMapping":{}}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "PATCH",
    "https://referally.15.204.158.166.sslip.io/v1/org/sso",
    headers={
    "Content-Type": "application/json",
    },
    json={"requireSso": True, "roleMapping": {}},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/org/sso", strings.NewReader(`{"requireSso":true,"roleMapping":{}}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/sso');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"requireSso":true,"roleMapping":{}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/sso')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"requireSso":true,"roleMapping":{}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/sso"))
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"requireSso\":true,\"roleMapping\":{}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "requireSso": true,
  "roleMapping": {}
}
Schema
requireSsobooleanrequired
roleMappingobjectrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/org/sso/link
POST /v1/org/sso/link
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/org/sso/link"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/sso/link', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/org/sso/link",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/org/sso/link", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/sso/link');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/sso/link')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/sso/link"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "linked": true,
  "provider": "string",
  "tenantId": "string",
  "atlasOrgId": "string"
}
Schema
linkedbooleanrequired
providerstringrequired
tenantIdstringrequired
atlasOrgIdstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/org/sso/tickets
POST /v1/org/sso/tickets
Request body application/json
expiresInDaysinteger
= 3
{
  "expiresInDays": 3
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets" \
  -H "Content-Type: application/json" \
  -d '{"expiresInDays":3}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"expiresInDays":3}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets",
    headers={
    "Content-Type": "application/json",
    },
    json={"expiresInDays": 3},
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets", strings.NewReader(`{"expiresInDays":3}`))
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"expiresInDays":3}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"expiresInDays":3}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"expiresInDays\":3}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "url": "string",
  "expiresAt": "2024-01-01T00:00:00Z"
}
Schema
idstringrequired
urlstringrequired
The SSO provider's hosted setup page for the IT admin. Shown once; not stored.
expiresAtstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke
POST /v1/org/sso/tickets/{id}/revoke
Parameters
idstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/sso/tickets/{id}/revoke"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "status": "string"
}
Schema
idstringrequired
statusstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata
GET /v1/org/sso/connections/{id}/saml-metadata
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/org/sso/connections/{id}/saml-metadata"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "spEntityId": "string",
  "acsUrl": "string",
  "metadataXml": "string"
}
Schema
spEntityIdstringrequired
acsUrlstringrequired
metadataXmlstringrequired
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}
POST /webhooks/sso/{provider}
Parameters
providerstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/webhooks/sso/{provider}"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "received": true,
  "duplicate": true,
  "handled": true,
  "effects": [
    "string"
  ]
}
Schema
receivedbooleanrequired
duplicatebooleanrequired
handledboolean
effectsstring[]
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/webhooks/atlas
POST /webhooks/atlas
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/webhooks/atlas"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/webhooks/atlas', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/webhooks/atlas",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/webhooks/atlas", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/webhooks/atlas');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/webhooks/atlas')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/webhooks/atlas"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "received": true,
  "duplicate": true,
  "handled": true,
  "effects": [
    "string"
  ]
}
Schema
receivedbooleanrequired
duplicatebooleanrequired
handledboolean
effectsstring[]
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}
POST /webhooks/payouts/{provider}
Parameters
providerstringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/webhooks/payouts/{provider}"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ignored": true,
  "reason": "string",
  "finalized": true,
  "status": "string"
}
Schema
ignoredboolean
reasonstring
finalizedboolean
statusstring
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css
GET /t/{orgToken}/theme.css
Parameters
orgTokenstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/t/{orgToken}/theme.css"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/embed.js
GET /embed.js
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/embed.js"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/embed.js', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/embed.js",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/embed.js", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/embed.js');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/embed.js')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/embed.js"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/embed-signup.js
GET /embed-signup.js
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/embed-signup.js"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/embed-signup.js', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/embed-signup.js",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/embed-signup.js", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/embed-signup.js');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/embed-signup.js')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/embed-signup.js"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}
GET /lead/{orgToken}/{code}
Parameters
orgTokenstringpathrequired
codestringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}
POST /lead/{orgToken}/{code}
Parameters
orgTokenstringpathrequired
codestringpathrequired
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/lead/{orgToken}/{code}"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 HTML thank-you page, or {"ok":true} when the request is JSON.
"string"
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
GEThttps://referally.15.204.158.166.sslip.io/v1/graphql
GET /v1/graphql
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/graphql"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/graphql', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/graphql",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/graphql", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/graphql');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/graphql')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/graphql"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "data": {},
  "errors": [
    {}
  ]
}
Schema
dataGetOpenapiJsonResponse
errorsGetOpenapiJsonResponse[]
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
POSThttps://referally.15.204.158.166.sslip.io/v1/graphql
POST /v1/graphql
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/graphql"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/graphql', {
  method: 'POST',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/graphql",
)
data = res.json()
Go
package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/graphql", nil)
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}
PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/graphql');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;
Ruby
require 'net/http'
require 'uri'

uri = URI('https://referally.15.204.158.166.sslip.io/v1/graphql')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body
Java
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/graphql"))
    .method("POST", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "data": {},
  "errors": [
    {}
  ]
}
Schema
dataGetOpenapiJsonResponse
errorsGetOpenapiJsonResponse[]
default Error
Example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "requestId": "string",
    "docs_url": "string"
  }
}
Schema
errorobjectrequired
Show child parameters
codestringrequired
messagestringrequired
details
requestIdstring
docs_urlstringrequired
The docs entry for this error code: what it means and how to fix it.
Updated