Get all leads

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

{
  "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": "[email protected]",
      "last_visited_at": "2024-03-14T12:00:00Z",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      }
    }
  ]
}

GET

leads

Get all leads

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

{
  "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": "[email protected]",
      "last_visited_at": "2024-03-14T12:00:00Z",
      "metadata": {
        "utm_source": "google",
        "utm_campaign": "campaign_name",
        "user_id": "1234567890"
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Response

Retrieve all leads

object

enum<string>

required

Available options:

list

items

object[]

required

Show child attributes

items.object

enum<string>

required

Available options:

lead

items.id

string

required

Unique identifier for the lead

Example:

"lead_a8n8ol7yd4h0wohx824f0bui"

items.link

string

required

URL of the lead

Example:

"https://nomos.checkout.energy/?id=lead_a8n8ol7yd4h0wohx824f0bui"

items.created_at

required

Timestamp when the lead was created

Example:

"2024-03-14T12:00:00Z"

items.subscription

string | null

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

Example:

"sub_a8n8ol7yd4h0wohx824f0bui"

items.subscribed_at

Timestamp when the lead was converted to a subscription

Example:

"2024-03-14T12:00:00Z"

items.created_by

string | null

Email of the user who created the lead

Example:

"[email protected]"

items.last_visited_at

Timestamp when the lead was last visited

Example:

"2024-03-14T12:00:00Z"

items.metadata

object

Metadata of the lead, can be internal data

Show child attributes

items.metadata.{key}

unknown

Example:

{
  "utm_source": "google",
  "utm_campaign": "campaign_name",
  "user_id": "1234567890"
}

Get a lead Create a lead

⌘I

API Reference

Authorizations

Response