v1

latestOpenAPI 3.0.02026-07-263365201.7 KB

Leads

List leads

Retrieve all leads with cursor pagination. Leads for feed-in plans are only available from the 2026-05-27.curie API version onwards.

get/leads

Query parameters

cursorstring nullable

limitnumber

filter[field][operator]string nullable

Filterable fields:

created_at (date)

See Filtering Documentation for supported operators and syntax.

Example:value

Filterable fields:

created_at (date)

See Filtering Documentation for supported operators and syntax.

Response

Retrieve all leads with cursor pagination. Leads for feed-in plans are only available from the 2026-05-27.curie API version onwards.

object'list' required

next_pagestring nullable

has_moreboolean

Example response

{
  "items": [
    {
      "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"
      }
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="
}