Get partner referral info + referred list

Overview

Get the authenticated partner's referral-programme details. By default it lazily creates the partner's own referral code (if none exists). It returns a paginated list of companies that signed up through it. It also returns the partner's own referral code, total click count and white-label URL as top-level additional keys. When you set call_for it instead returns the URL-widget info (also lazily creating the widget row). Side effect: may create a referral_codes row and/or a widgets row on first call.

Prerequisites

• A bearer token in the Authorization header.

Base URL

Endpoint

GET /api/v1/referral/partner-info

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Any valid bearer token (no role or bundle gate). The endpoint self-scopes the referral list to the caller's own company (referral_company_id = auth company id).

Rate limit

• No rate limit.

Query parameters

How it works

• 200 (default) — paginated collection: { data: [.], links, meta } plus top-level white_label_url, referral_code, total_click. Each row: id, account_name, company_id, referral_company_id, landing_page_url (Google landing page for bundle_id=2 accounts), code, total_click, total_location, created_at.
• 200 (call_for set) — { data: { status, message, referral_code, widget_text } }.

Response

200 OK (referral list) · 200

{
  "data": [
    {
      "id": 1,
      "account_name": "Example Name",
      "company_id": 12,
      "referral_company_id": 10,
      "landing_page_url": "https://example.com/sample",
      "code": "ABC123",
      "total_click": 10,
      "total_location": 3,
      "created_at": "2026-06-16T09:48:56.000000Z"
    }
  ],
  "links": {
    "first": "https://production-api.shoutaboutus.com/api/v1/referral/partner-info?page=1",
    "last": "https://production-api.shoutaboutus.com/api/v1/referral/partner-info?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "per_page": 10,
    "total": 1
  },
  "white_label_url": "https://app.example.com",
  "referral_code": "AbCdEf1234",
  "total_click": 42
}

200 OK (call_for=widget) · 200

{
  "data": {
    "status": "success",
    "message": "Referral code has been retrieved successfully",
    "referral_code": "AbCdEf1234",
    "widget_text": "<p>Need Help responding to your reviews?</p>"
  }
}

Errors

Example request

curl --request GET \
  --url "https://production-api.shoutaboutus.com/api/v1/referral/partner-info?sort_field=id&sort_by=DESC&limit=10" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json'