Get Referred Businesses
curl --request GET \
--url https://api.rolla.xyz/api/v1/external/broker/referred-businesses \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.rolla.xyz/api/v1/external/broker/referred-businesses"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.rolla.xyz/api/v1/external/broker/referred-businesses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/broker/referred-businesses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.rolla.xyz/api/v1/external/broker/referred-businesses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.rolla.xyz/api/v1/external/broker/referred-businesses")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/broker/referred-businesses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": 200,
"message": "Referred businesses fetched successfully",
"success": true,
"data": [
{
"id": "d4e5f6a7-b8c9-4123-9def-456789012345",
"name": "Acme Corp Ltd",
"email": "contact@acmecorp.com",
"status": "completed",
"created_at": "2024-01-15T10:30:00.000Z",
"application_status": "approved",
"negotiation_enabled": false
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 15,
"totalPages": 1
}
}{
"status": 400,
"message": "Validation failed",
"errors": [
{
"path": [
"status"
],
"message": "Invalid enum value. Expected 'started' | 'completed' | 'created' | 'approved'"
}
]
}{
"status": 400,
"message": "Validation failed",
"code": "ACCOUNT_RESTRICTED",
"errors": [
{
"path": [
"amount"
],
"message": "amount must be a whole number of smallest currency units (e.g. cents)"
}
]
}{
"status": 403,
"message": "Business is not activated as a broker"
}Get Referred Businesses
Retrieves a paginated list of the businesses that registered through your referral links, newest first. data is the array of businesses and pagination sits beside it at the top level rather than inside data.
GET
/
broker
/
referred-businesses
Get Referred Businesses
curl --request GET \
--url https://api.rolla.xyz/api/v1/external/broker/referred-businesses \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.rolla.xyz/api/v1/external/broker/referred-businesses"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.rolla.xyz/api/v1/external/broker/referred-businesses', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.rolla.xyz/api/v1/external/broker/referred-businesses",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.rolla.xyz/api/v1/external/broker/referred-businesses"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.rolla.xyz/api/v1/external/broker/referred-businesses")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.rolla.xyz/api/v1/external/broker/referred-businesses")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"status": 200,
"message": "Referred businesses fetched successfully",
"success": true,
"data": [
{
"id": "d4e5f6a7-b8c9-4123-9def-456789012345",
"name": "Acme Corp Ltd",
"email": "contact@acmecorp.com",
"status": "completed",
"created_at": "2024-01-15T10:30:00.000Z",
"application_status": "approved",
"negotiation_enabled": false
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 15,
"totalPages": 1
}
}{
"status": 400,
"message": "Validation failed",
"errors": [
{
"path": [
"status"
],
"message": "Invalid enum value. Expected 'started' | 'completed' | 'created' | 'approved'"
}
]
}{
"status": 400,
"message": "Validation failed",
"code": "ACCOUNT_RESTRICTED",
"errors": [
{
"path": [
"amount"
],
"message": "amount must be a whole number of smallest currency units (e.g. cents)"
}
]
}{
"status": 403,
"message": "Business is not activated as a broker"
}Retrieve a paginated list of businesses you have referred. Filter by referral status.
Businesses are returned newest first.
Broker activation is required. Broker accounts are activated by the Rolla admin team — you cannot activate a broker account yourself through the API. Once your business has been activated as a broker by Rolla, all broker endpoints become available. Until then, all requests will return a
403 Forbidden error. Contact support@rolla.xyz to request broker activation.Example Request
curl -X GET "https://api.rolla.xyz/api/v1/external/broker/referred-businesses?page=1&pageSize=20&status=completed" \
-H "X-API-Key: your_api_key_here"
Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
pageSize | integer | Results per page (default: 20, max: 100) |
status | string | Filter by onboarding status: created, started, completed, approved |
data is the array of businesses and pagination sits beside it at the top level, not inside data.
Example Response
{
"status": 200,
"message": "Referred businesses fetched successfully",
"success": true,
"data": [
{
"id": "d4e5f6a7-b8c9-4123-9def-456789012345",
"name": "Acme Corp Ltd",
"email": "contact@acmecorp.com",
"status": "completed",
"created_at": "2024-01-15T10:30:00.000Z",
"application_status": "approved",
"negotiation_enabled": false
}
],
"pagination": {
"page": 1,
"pageSize": 20,
"total": 15,
"totalPages": 1
}
}
status is the business’s own onboarding status (created, started, completed, expired). The KYB decision is application_status (draft, submitted, approved, rejected, changes_requested, deactivated, blacklisted, deleted), and it is null until the business starts a KYB application. Once application_status is approved the business is live and you start earning commissions from its transactions.The
status filter is matched against the business’s onboarding status, so filtering by approved returns no rows. Filter by completed and read application_status instead.Authorizations
Your Rolla API key
Query Parameters
Page number
Required range:
x >= 1Example:
1
Results per page
Required range:
1 <= x <= 100Example:
20
Filter by the business's onboarding status. approved is accepted but matches no rows: the KYB decision is reported separately as application_status.
Available options:
started, completed, created, approved Example:
"completed"
Response
Referred businesses fetched successfully
Example:
200
Example:
"Referred businesses fetched successfully"
Example:
true
Show child attributes
Show child attributes
Paging block used by the listings that nest one. The transaction listings do not: they return totalCount, page, pageSize and totalPages flat alongside transactions.
Show child attributes
Show child attributes