Get a referral

Read a single referral back, including its rewards and which payee each one landed on. Requires partners_read.

Lookup is by Lasso Lead Key by default. Use ?by=external with the CRM system and object type to address a referral by a record id you already hold, with nothing Lasso-specific stored.

get/leads/{identifier}

Request

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

Path parameters

identifierstring required

Referral identifier (Lasso Lead Key by default, or a value matching by)

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

The referral

Example response

{
  "lead": {
    "slug": "abc-123",
    "source_type": "referral_link",
    "company_name": "Lead Company",
    "contact_name": "Jane Doe",
    "email": "jane@leadco.com",
    "partner_slug": "acme-corp",
    "partner_lasso_key": "P-A1B2C3",
    "partner_member": {
      "slug": "PC-A1B2C3"
    },
    "currency_code": "USD",
    "billing_start_date": "2026-10-01"
  }
}

Changes

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