GET/api/v2/admin/referrals/invite-benefits

GET /api/v2/admin/referrals/invite-benefits

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
FieldTypeRequiredDescription
companyId (query)unknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
OwnerUserIdunknownYes
OwnerNamestringYes
OwnerEmailstringYes
ReferralCodestringYes
ReferredTierIdunknownYes
ReferredTierNamestringYes
DiscountCodeIdunknownYes
DiscountCodestringYes
DiscountDescriptionstringYes
InheritBenefitsbooleanYes
UpdatedAtstring (date-time)Yes

Example request

curl -X GET "https://{base_url}/api/v2/admin/referrals/invite-benefits" \
  -H "x-api-key: YOUR_API_KEY"

This page is generated from the live OpenAPI specification and always matches the current API.