Skip to main content
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>'
{
  "success": true,
  "message": "Referred businesses retrieved successfully",
  "data": {
    "businesses": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "businessName": "<string>",
        "email": "jsmith@example.com",
        "status": "started",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "pagination": {
      "page": 123,
      "pageSize": 123,
      "total": 123
    }
  }
}
Retrieve a paginated list of businesses you have referred. Filter by referral status.

​
Example Request

curl -X GET "https://api.rolla.xyz/api/v1/external/broker/referred-businesses?page=1&pageSize=20&status=approved" \
  -H "X-API-Key: your_api_key_here"

​
Query Parameters

ParameterTypeDescription
pageintegerPage number (default: 1)
pageSizeintegerResults per page (default: 20, max: 100)
statusstringFilter by status: started, completed, created, approved

​
Example Response

{
  "success": true,
  "message": "Referred businesses retrieved successfully",
  "data": {
    "businesses": [
      {
        "id": "d4e5f6a7-b8c9-0123-defg-456789012345",
        "businessName": "Acme Corp Ltd",
        "email": "contact@acmecorp.com",
        "status": "approved",
        "created_at": "2024-01-15T10:30:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 20,
      "total": 15
    }
  }
}
The approved status means the referred business has completed KYB verification and is active. You will start earning commissions from their transactions.

Authorizations

​
X-API-Key
string
header
required

Your Rolla API key

Query Parameters

​
page
integer
default:1

Page number (default: 1)

Required range: x >= 1
​
pageSize
integer
default:20

Results per page (default: 20, max: 100)

Required range: 1 <= x <= 100
​
status
enum<string>

Filter by referral status

Available options:
started,
completed,
created,
approved

Response

Referred businesses retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Referred businesses retrieved successfully"

​
data
object