Leads

List the rewards on a referral

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.

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

Path parameters

lead_identifierstring required

Referral identifier (slug by default, or value matching by param)

Query parameters

by'slug' | 'id' | 'email' | 'company_name' | 'external'

How to read the referral identifier in the path. See Resource Lookup.

external_system_typestring

Required when by=external. e.g. HUBSPOT, SALESFORCE, PIPEDRIVE

external_object_typestring

Required when by=external (optional for a Salesforce partner). e.g. company, deal, opportunity, account

Response

Rewards on the referral

lead_slugstring
lead_statusstring

Example response

{
  "lead_rewards": [
    {
      "name": "Tier 1 Call Held Bonus",
      "invoices": [
        {
          "status": "draft"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.