Sign in

v1

latestOpenAPI 3.0.02026-07-263365201.7 KB
Leads

Retrieve a lead

Retrieve lead details by its id

get/leads/{id}

Path parameters

idstring required
Example:lead_mi4f0oda6x9m7gcsvjk0ole1

Response

Retrieve the lead details

object'lead' required
idstring required

Unique identifier for the lead

subscriptionstring nullable

ID of the subscription, if the lead is converted to a subscription

linkstring required

URL of the lead

created_bystring nullable

Email of the user who created the lead

metadataobject nullable

Metadata of the lead, can be internal data

Example response

{
  "id": "lead_a8n8ol7yd4h0wohx824f0bui",
  "subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
  "link": "https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui",
  "created_by": "john.doe@example.com",
  "metadata": {
    "utm_source": "google",
    "utm_campaign": "campaign_name",
    "user_id": "1234567890"
  }
}