Skip to main content
GET
Get Referred Businesses
Retrieve a paginated list of businesses you have referred. Filter by referral status.
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

Query Parameters

Businesses are returned newest first. data is the array of businesses and pagination sits beside it at the top level, not inside data.

Example Response

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

X-API-Key
string
header
required

Your Rolla API key

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
Example:

1

pageSize
integer
default:20

Results per page

Required range: 1 <= x <= 100
Example:

20

status
enum<string>

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

status
integer
required
Example:

200

message
string
required
Example:

"Referred businesses fetched successfully"

success
boolean
required
Example:

true

data
object[]
required
pagination
object
required

Paging block used by the listings that nest one. The transaction listings do not: they return totalCount, page, pageSize and totalPages flat alongside transactions.