get
https://production-api.shoutaboutus.com/api/v1/referral/partner-info
Get the authenticated partner's referral-programme details. By default it lazily creates the partner's own referral code (if none exists) and returns a paginated list of companies that signed up through it, plus 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.
Auth
- Bearer partner token. The endpoint scopes the referral list to the caller's own company (
referral_company_id = auth company id).
Rate limit
- No rate limit.
Query
| Field | Type | Required | Notes |
|---|---|---|---|
call_for | string | Optional | When present (e.g. widget), returns the URL-widget payload instead of the referral list. |
search_field | string | Optional | One of account_name, code, total_click. Chooses which column search_value filters. |
search_value | string | Optional | Filter value for search_field (LIKE for account_name, exact otherwise). |
sort_field | string | Optional | id or total_click (anything else falls back to id). Default id. |
sort_by | string | Optional | ASC or DESC (default DESC). |
limit | integer | Optional | Page size. Default 10. |
Behaviour
200(default) — paginated collection:{ data: [.], links, meta }plus top-levelwhite_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_forset) —{ data: { status, message, referral_code, widget_text } }.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…