GET
/api/v2/referrals/optionsEligible offer choices and up to 50 company users matching a search.
Authentication
Send your API key in the x-api-key header on every request.
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| search (query) | string | No |
Responses
200 — OK
| Field | Type | Required | Description |
|---|---|---|---|
| Users | array of ReferralUserOption | Yes | |
| HasMoreUsers | boolean | Yes | |
| Tiers | array of ReferralTierOption | Yes | |
| DiscountCodes | array of DiscountCodeResponse | Yes |
Example request
curl -X GET "https://{base_url}/api/v2/referrals/options" \
-H "x-api-key: YOUR_API_KEY"This page is generated from the live OpenAPI specification and always matches the current API.