Skip to content

List gifts I drove​

GET
/me/referrals/gifts

The donations attributed to the caller's referral links in the window, refunded, failed and self-referred gifts included. Each row carries exactly the fields of AmbassadorGift: no donor email, card details or receipt reference, and no donor name on an anonymous gift.

Requires permission: view_own_referral_portal.

Authorizations​

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type
HTTP (bearer)

Parameters​

Query Parameters

from

Window start. Defaults to 28 days before to. Must be before to and not earlier than 2020-01-01.

Type
string
Format
"date-time"
to

Window end. Defaults to now.

Type
string
Format
"date-time"
limit
Type
integer
Minimum
1
Maximum
200
Default
50
offset
Type
integer
Minimum
0
Default
0

Responses​

One page of gifts

application/json
JSON
{
"data": [
],
"total": 0,
"drivenTotal": 0,
"range": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress