---
title: "List the rewards on a referral"
method: GET
path: "/leads/{lead_identifier}/rewards"
tags: ["Leads"]
---

# List the rewards on a referral

`GET /leads/{lead_identifier}/rewards`

## Request

- Base URL: `https://api.lassotech.com/api/v1/rest`
- URL: `https://api.lassotech.com/api/v1/rest/leads/{lead_identifier}/rewards`
- Auth: API key in header `x-lasso-access-token`

Lists the rewards attached to a referral, with the invoices raised against each one and
whether it can still be removed. This is what makes a remove-by-exception automation safe
to write: a bonus whose invoice has already been paid cannot be taken back, and
`removable` says so before you try.

Look up the referral by slug (default), id, email, company_name, or external ID using the
`?by=` query param, so a CRM deal id resolves the referral with no Lasso identifier to
store. Requires `payment_read` or `payment_write` permission.

## Path parameters

- `lead_identifier` string, required

## Query parameters

- `by` 'slug' | 'id' | 'email' | 'company_name' | 'external'
- `external_system_type` string
- `external_object_type` string

## Response `200`

Rewards on the referral

- object
  - `lead_slug` string
  - `lead_status` string
  - `lead_rewards` LeadReward[]
    - `id` integer
    - `name` string
    - `reward_type` 'QUALIFIED_LEAD_FIXED' | 'CLOSED_WON_FIXED' | 'CLOSED_WON_PERCENTAGE' | 'ONE_TIME_PAYOUT': Rewards created through this API are QUALIFIED_LEAD_FIXED, CLOSED_WON_FIXED or CLOSED_WON_PERCENTAGE; ONE_TIME_PAYOUT only appears on rewards that came from elsewhere.
    - `amount` number, float
    - `amount_type` 'fixed_amount' | 'percentage'
    - `period_months` integer, nullable: How long a revenue share runs. Null for fixed-amount rewards, which bill once.
    - `currency` string
    - `external_identifier` string, nullable: The identifier you created the reward with. Null for rewards copied from a reward plan or added in the Lasso admin.
    - `source` 'reward_plan' | 'ad_hoc': Whether the reward came from the partner's reward plan or was attached to this referral alone.
    - `reward_plan` object, nullable
      - `segment_reward_id` integer
      - `segment_slug` string
      - `segment_name` string
    - `payee` object: Who the reward pays. A reward pays either the partner organization or one partner contact, never both.
      - `type` 'partner' | 'partner_user'
      - `partner_slug` string, nullable
      - `partner_name` string, nullable
      - `partner_user_slug` string, nullable
      - `email` string, nullable
    - `external_title` string, nullable
    - `external_description` string, nullable
    - `internal_description` string, nullable
    - `visible_to_partners` boolean
    - `invoices` LeadRewardInvoice[]: Every invoice raised against this reward, voided ones included.
      - `slug` string
      - `status` 'draft' | 'payment_ready' | 'finalized' | 'paid' | 'voided': The invoice's current status. A reward with a finalized or paid invoice can no longer be removed.
      - `amount` number, float
      - `currency` string
      - `invoice_on` string, date
      - `due_on` string, date
      - `paid_at` string, date-time, nullable
    - `removable` boolean: False once one of the reward's invoices is finalized or paid. Removing it then is refused.
    - `removal_blocked_reason` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401`: Missing or invalid API key
- `403`: API key lacks required permission
- `404`: Resource not found
- `429`: Rate limit exceeded. Wait the number of seconds in `Retry-After`, then retry.

---

[API](https://skmtc.dev/onelasso/apis/lasso-rest-api.md) · [All operations](https://skmtc.dev/onelasso/apis/lasso-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onelasso/apis/lasso-rest-api/revisions/bbc328f5e2d1?raw)