List leads

curl --request GET \
  --url https://api.nomos.energy/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nomos.energy/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomos.energy/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomos.energy/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "items": [
    {
      "object": "lead",
      "id": "lead_a8n8ol7yd4h0wohx824f0bui",
      "link": "https://nomos.checkout.energy?id=lead_a8n8ol7yd4h0wohx824f0bui",
      "created_at": "2024-03-14T12:00:00Z",
      "subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
      "subscribed_at": "2024-03-14T12:00:00Z",
      "created_by": "john.doe@example.com",
      "last_visited_at": "2024-03-14T12:00:00Z",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      }
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0=",
  "has_more": false
}

GET

leads

List leads

curl --request GET \
  --url https://api.nomos.energy/leads \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.nomos.energy/leads', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.nomos.energy/leads",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.nomos.energy/leads"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.nomos.energy/leads")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "object": "list",
  "items": [
    {
      "object": "lead",
      "id": "lead_a8n8ol7yd4h0wohx824f0bui",
      "link": "https://nomos.checkout.energy?id=lead_a8n8ol7yd4h0wohx824f0bui",
      "created_at": "2024-03-14T12:00:00Z",
      "subscription": "sub_a8n8ol7yd4h0wohx824f0bui",
      "subscribed_at": "2024-03-14T12:00:00Z",
      "created_by": "john.doe@example.com",
      "last_visited_at": "2024-03-14T12:00:00Z",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      }
    }
  ],
  "next_page": "eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0=",
  "has_more": false
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor

string | null

limit

number

default:10

Required range: 1 <= x <= 100

filter[field][operator]

any | null

Filterable fields:

created_at (date): gte, lte, is_null

Any other field or operator returns 400. See Filtering Documentation for the syntax.

Example:

"value"

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

enum<string>

required

Available options:

list

items

object[]

required

Show child attributes

next_page

string | null

Example:

"eyJsYXN0X2NyZWF0ZWRfYXQiOiIyMDI1LTAxLTE1VDEwOjMwOjAwLjAwMFoiLCJsYXN0X2lkIjoic3ViX21pNGYwb2RhNng5bTdnY3N2amswb2xlMSIsImxpbWl0IjoyMH0="

has_more

boolean

default:false