Data and privacy

Embed
Preview of the card
<a href="https://referalli.com/docs/ref-data-and-privacy"><img src="https://referalli.com/docs/_api/public/orgs/07f432f4-34b9-46a7-aaad-c0e395d2e4f9/spaces/2bf4f614-3630-4fbf-85f9-5ecafa6b7d97/pages/728ddbb0-269f-4afc-9712-a25230ed4b54/social-card.svg?v=3e7ae33eec8b" alt="Data and privacy" width="600" height="315"></a>
GEThttps://referally.15.204.158.166.sslip.io/v1/export/accounting
QuickBooks/Xero payout CSV
Parameters
formatstringquery
quickbooks | xero = quickbooks
yearintegerqueryrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/export/accounting?format=&year="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/export/accounting?format=&year=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/export/accounting?format=&year=",
)
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/export/accounting?format=&year=", 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/export/accounting?format=&year=');
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/export/accounting?format=&year=')
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/export/accounting?format=&year="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 QuickBooks or Xero CSV of sent payouts.
"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/export/full
Full-org NDJSON data export
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/export/full"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/export/full', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/export/full",
)
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/export/full", 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/export/full');
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/export/full')
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/export/full"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Every tenant table, one {"table","row"} object per line.
"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/privacy/export
GDPR data-subject export
Parameters
customerRefstringqueryrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/privacy/export?customerRef="
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/export?customerRef=', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/export?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/privacy/export?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/privacy/export?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/privacy/export?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/privacy/export?customerRef="))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "customerRef": "string",
  "referrals": [
    {}
  ],
  "associations": [
    {}
  ],
  "identityLinks": [
    {}
  ],
  "billingEvents": [
    {}
  ],
  "conversionEvents": [
    {}
  ]
}
Schema
customerRefstringrequired
referralsGetOpenapiJsonResponse[]required
associationsGetOpenapiJsonResponse[]required
identityLinksGetOpenapiJsonResponse[]required
billingEventsGetOpenapiJsonResponse[]required
conversionEventsGetOpenapiJsonResponse[]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/privacy/forget
GDPR erasure of a customer, partner or email (audited pseudonymization)
Request body application/json
emailstring
customerRefstring
partnerIdstring
{
  "email": "string",
  "customerRef": "string",
  "partnerId": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/privacy/forget" \
  -H "Content-Type: application/json" \
  -d '{"email":"string","customerRef":"string","partnerId":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/forget', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"email":"string","customerRef":"string","partnerId":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/forget",
    headers={
    "Content-Type": "application/json",
    },
    json={"email": "string", "customerRef": "string", "partnerId": "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/privacy/forget", strings.NewReader(`{"email":"string","customerRef":"string","partnerId":"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/privacy/forget');
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","customerRef":"string","partnerId":"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/privacy/forget')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"email":"string","customerRef":"string","partnerId":"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/privacy/forget"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"email\":\"string\",\"customerRef\":\"string\",\"partnerId\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "ok": true,
  "pseudonym": "string",
  "partners": [
    {
      "partnerId": "string",
      "alreadyForgotten": true
    }
  ],
  "customers": [
    {
      "customerRef": "string",
      "pseudonym": "string"
    }
  ]
}
Schema
okbooleanrequired
pseudonymstring
Erasure by customerRef.
partnersobject[]
Show child parameters
partnerIdstringrequired
alreadyForgottenbooleanrequired
customersobject[]
Show child parameters
customerRefstringrequired
pseudonymstringrequired
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/privacy/lookup
Find a data subject by email (hashed server-side)
Request body application/json
emailstringrequired
{
  "email": "string"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/privacy/lookup" \
  -H "Content-Type: application/json" \
  -d '{"email":"string"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/lookup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"email":"string"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/lookup",
    headers={
    "Content-Type": "application/json",
    },
    json={"email": "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/privacy/lookup", strings.NewReader(`{"email":"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/privacy/lookup');
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"}');
$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/privacy/lookup')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"email":"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/privacy/lookup"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"email\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "found": true,
  "customerRefs": [
    "string"
  ],
  "partnerId": "string"
}
Schema
foundbooleanrequired
customerRefsstring[]required
partnerIdstringrequired
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/privacy/requests
List data-subject requests
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/privacy/requests"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/requests', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/requests",
)
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/privacy/requests", 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/privacy/requests');
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/privacy/requests')
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/privacy/requests"))
    .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",
      "type": "access",
      "subject": {},
      "status": "pending",
      "error": "string",
      "createdAt": "2024-01-01T00:00:00Z",
      "completedAt": "2024-01-01T00:00:00Z",
      "resultUrl": "string",
      "result": {}
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}
Schema
objectstringrequired
dataPrivacyRequest[]required
Show child parameters
idstringrequired
typestringrequired
access | erasure
subjectobjectrequired
statusstringrequired
pending | completed | failed
errorstringrequired
createdAtstringrequired
completedAtstringrequired
resultUrlstring
resultobject
Erasure receipts, on the single-request read.
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/privacy/requests
Open an access or erasure request
Request body application/json
subjectobjectrequired
Show child parameters
emailstring
customerRefstring
partnerIdstring
typestringrequired
access | erasure
{
  "subject": {
    "email": "string",
    "customerRef": "string",
    "partnerId": "string"
  },
  "type": "access"
}
Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/privacy/requests" \
  -H "Content-Type: application/json" \
  -d '{"subject":{"email":"string","customerRef":"string","partnerId":"string"},"type":"access"}'
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/requests', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"subject":{"email":"string","customerRef":"string","partnerId":"string"},"type":"access"}),
});
const data = await res.json();
Python
import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/requests",
    headers={
    "Content-Type": "application/json",
    },
    json={"subject": {"email": "string", "customerRef": "string", "partnerId": "string"}, "type": "access"},
)
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/privacy/requests", strings.NewReader(`{"subject":{"email":"string","customerRef":"string","partnerId":"string"},"type":"access"}`))
	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/privacy/requests');
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, '{"subject":{"email":"string","customerRef":"string","partnerId":"string"},"type":"access"}');
$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/privacy/requests')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"subject":{"email":"string","customerRef":"string","partnerId":"string"},"type":"access"}'
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/privacy/requests"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"subject\":{\"email\":\"string\",\"customerRef\":\"string\",\"partnerId\":\"string\"},\"type\":\"access\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
202 OK
Example
{
  "id": "string",
  "status": "completed"
}
Schema
idstringrequired
statusstringrequired
completed | failed
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/privacy/requests/{id}
Poll a data-subject request
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/privacy/requests/{id}"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/requests/{id}', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/requests/{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/privacy/requests/{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/privacy/requests/{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/privacy/requests/{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/privacy/requests/{id}"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 OK
Example
{
  "id": "string",
  "type": "access",
  "subject": {},
  "status": "pending",
  "error": "string",
  "createdAt": "2024-01-01T00:00:00Z",
  "completedAt": "2024-01-01T00:00:00Z",
  "resultUrl": "string",
  "result": {}
}
Schema
idstringrequired
typestringrequired
access | erasure
subjectobjectrequired
statusstringrequired
pending | completed | failed
errorstringrequired
createdAtstringrequired
completedAtstringrequired
resultUrlstring
resultobject
Erasure receipts, on the single-request read.
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/privacy/requests/{id}/result
Download a completed request result
Parameters
idstringpathrequired
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/privacy/requests/{id}/result"
TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/privacy/requests/{id}/result', {
  method: 'GET',
});
const data = await res.json();
Python
import requests

res = requests.request(
    "GET",
    "https://referally.15.204.158.166.sslip.io/v1/privacy/requests/{id}/result",
)
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/privacy/requests/{id}/result", 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/privacy/requests/{id}/result');
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/privacy/requests/{id}/result')
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/privacy/requests/{id}/result"))
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
Responses
200 Access requests return the export; erasure requests the receipts.
Example
{
  "found": true,
  "customers": [
    {
      "customerRef": "string",
      "referrals": [
        null
      ],
      "associations": [
        null
      ],
      "identityLinks": [
        null
      ],
      "billingEvents": [
        null
      ],
      "conversionEvents": [
        null
      ]
    }
  ],
  "partner": {
    "partner": {},
    "enrollments": [
      {}
    ],
    "links": [
      {}
    ],
    "coupons": [
      {}
    ],
    "payoutProfile": {},
    "commissionEvents": [
      {}
    ],
    "payouts": [
      {}
    ]
  },
  "partners": [
    {
      "partnerId": "string",
      "alreadyForgotten": true
    }
  ]
}
Schema
foundbooleanrequired
customersCustomerExport | object[]required
partnerPartnerExport
Show child parameters
partnerobjectrequired
enrollmentsGetOpenapiJsonResponse[]required
linksGetOpenapiJsonResponse[]required
couponsGetOpenapiJsonResponse[]required
payoutProfileGetOpenapiJsonResponserequired
commissionEventsGetOpenapiJsonResponse[]required
payoutsGetOpenapiJsonResponse[]required
partnersobject[]
Show child parameters
partnerIdstringrequired
alreadyForgottenbooleanrequired
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