Deals

Embed

<a href="https://referalli.com/docs/ref-deals"><img src="https://referalli.com/docs/_api/public/orgs/07f432f4-34b9-46a7-aaad-c0e395d2e4f9/spaces/2bf4f614-3630-4fbf-85f9-5ecafa6b7d97/pages/9a030819-06c1-4438-80ec-7181744accaf/social-card.svg?v=3e7ae33eec8b" alt="Deals" width="600" height="315"></a>

GEThttps://referally.15.204.158.166.sslip.io/v1/deals

GET /v1/deals

Code samples

cURL

curl -X GET "https://referally.15.204.158.166.sslip.io/v1/deals"

TypeScript

const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/deals', {
  method: 'GET',
});
const data = await res.json();

Python

import requests

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

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/deals", 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/deals');
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/deals')
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/deals"))
    .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",
      "partnerEmail": "string",
      "company": "string",
      "contactEmail": "string",
      "valueMinor": 0,
      "currency": "string",
      "status": "string",
      "protectionExpiresAt": "2024-01-01T00:00:00Z",
      "referralId": "string",
      "notes": "string",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "string"
}

Schema

objectstringrequired

dataobject[]required

Show child parameters

idstringrequired

programIdstringrequired

partnerIdstringrequired

partnerEmailstringrequired

companystringrequired

contactEmailstringrequired

valueMinorintegerrequired

Integer minor units (cents).

currencystringrequired

statusstringrequired

protectionExpiresAtstringrequired

referralIdstringrequired

notesstringrequired

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/deals/{id}/approve

Approve a registered deal (protection window)

Parameters

idstringpathrequired

Request body application/json

protectionDaysinteger

= 90

{
  "protectionDays": 90
}

Code samples

cURL

curl -X POST "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/approve" \
  -H "Content-Type: application/json" \
  -d '{"protectionDays":90}'

TypeScript

const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/deals/{id}/approve', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"protectionDays":90}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/approve",
    headers={
    "Content-Type": "application/json",
    },
    json={"protectionDays": 90},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/approve", strings.NewReader(`{"protectionDays":90}`))
	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/deals/{id}/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, '{"protectionDays":90}');
$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/deals/{id}/approve')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"protectionDays":90}'
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/deals/{id}/approve"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"protectionDays\":90}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 OK

Example

{
  "id": "string",
  "status": "string",
  "protectionExpiresAt": "2024-01-01T00:00:00Z"
}

Schema

idstringrequired

statusstringrequired

protectionExpiresAtstringrequired

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/deals/{id}/reject

POST /v1/deals/{id}/reject

Parameters

idstringpathrequired

Code samples

cURL

curl -X POST "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/reject"

TypeScript

const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/deals/{id}/reject', {
  method: 'POST',
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/reject",
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/reject", 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/deals/{id}/reject');
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/deals/{id}/reject')
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/deals/{id}/reject"))
    .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.

POSThttps://referally.15.204.158.166.sslip.io/v1/deals/{id}/won

Convert a won deal into a commissionable referral

Parameters

idstringpathrequired

Request body application/json

customerRefstringrequired

{
  "customerRef": "string"
}

Code samples

cURL

curl -X POST "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/won" \
  -H "Content-Type: application/json" \
  -d '{"customerRef":"string"}'

TypeScript

const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/deals/{id}/won', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"customerRef":"string"}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/won",
    headers={
    "Content-Type": "application/json",
    },
    json={"customerRef": "string"},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/deals/{id}/won", strings.NewReader(`{"customerRef":"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/deals/{id}/won');
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"}');
$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/deals/{id}/won')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"customerRef":"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/deals/{id}/won"))
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"customerRef\":\"string\"}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 OK

Example

{
  "id": "string",
  "status": "string",
  "referralId": "string"
}

Schema

idstringrequired

statusstringrequired

referralIdstringrequired

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 Oct 22, 2026

Was this page helpful?