Skip to main content
GET
The advocate is the person who made the referral. Results are sorted by created_at, newest first.
If the customer has no referral code yet (no advocate record), the response is {"data": []} with no meta object.
Requires the read:referrals scope. See Scopes.

Query parameters

string
required
The platform customer ID (for example, the Shopify customer ID).
enum<string>
Return only referrals with this status. One of pending, rewarded, cancelled, expired, fraudulent.
integer
default:20
The number of results per page. Must be between 1 and 100.
integer
default:1
The page number to retrieve. See Classic pagination.

Response

object[]
The referral transactions on this page.
object

Errors