GET/v1/customers/{external_id}/referrals

List a customer's referrals

Returns the friends who took the customer's referral codes, each with its friend offer, when it was taken and whether the referrer's reward is pending, given or skipped. A customer token's answer leaves out each friend's external ID. Needs customers:read or billing:self.

curl 'https://api.entitler.co/v1/customers/ada/referrals' \
  -H "Authorization: Bearer $ENTITLER_KEY"

Credentials

Send any one of these:

Bearer token

Path parameters

Name	Type	Description
`external_id`required	string	The customer's external ID, or `me` for the customer a customer token or identity token names.

Query parameters

Name	Type	Description
`target.team_id`	string
`target.project_id`	string
`target.environment_id`	string
`page_size`	integer (int64)
`after`	string

Responses

`200`The ListReferralsResponse message.

ListReferralsResponse

nextstring
referralsarray of Referralrequired
- friendErasedbooleanrequired
- friendExternalIdstring
- friendOfferKeystringrequired
- idstringrequired
- rewardReferralRewardStaterequired
  One of REFERRAL_REWARD_STATE_UNSPECIFIED, REFERRAL_REWARD_STATE_PENDING, REFERRAL_REWARD_STATE_GIVEN, REFERRAL_REWARD_STATE_SKIPPED.
- settledAtinteger
  at least 0; at most 18446744073709552000
- skipReasonReferralRewardSkiprequired
  One of REFERRAL_REWARD_SKIP_UNSPECIFIED, REFERRAL_REWARD_SKIP_NO_SUBSCRIPTION, REFERRAL_REWARD_SKIP_PROVIDER_COLLECTED, REFERRAL_REWARD_SKIP_DISCOUNTS_FULL, REFERRAL_REWARD_SKIP_OFFER_ARCHIVED, REFERRAL_REWARD_SKIP_OFFER_USED_UP, REFERRAL_REWARD_SKIP_REFUSED, REFERRAL_REWARD_SKIP_FRIEND_LEFT.
- takenAtintegerrequired
  at least 0; at most 18446744073709552000

`Error`A refusal, with the HTTP status of its gRPC code.

Error

errorobjectrequired
- codestringrequired
- parametersobjectrequired
  Each value: string
- reasonstringor nullrequired