{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Nomos","colors":{"primary":"#1b1915","light":"#ffffff","dark":"#1b1915"},"logo":{"light":"https://mintcdn.com/riverslate/0nQqndf6SGR4MtUC/logo/light.svg?fit=max\u0026auto=format\u0026n=0nQqndf6SGR4MtUC\u0026q=85\u0026s=99c5d32286bf07989f99539ad1584d34","dark":"https://mintcdn.com/riverslate/0nQqndf6SGR4MtUC/logo/dark.svg?fit=max\u0026auto=format\u0026n=0nQqndf6SGR4MtUC\u0026q=85\u0026s=1e24faf333cc5cbbaa6454764020bc7d"},"favicon":"https://mintcdn.com/riverslate/i0UKnKz5dNnV7CMC/favicon.ico?fit=max\u0026auto=format\u0026n=i0UKnKz5dNnV7CMC\u0026q=85\u0026s=019f4931cf3d704bd7a11ab89eec374e","api":{"openapi":["openapi/openapi.chucky.json"]},"appearance":{"default":"light"},"background":{"color":{"light":"#f6f3f0","dark":"#21262c"}},"navbar":{"links":[{"href":"https://dashboard.nomos.energy","label":"Dashboard"}],"primary":{"type":"button","label":"Book Demo","href":"https://nomos.energy/demo"}},"footer":{"socials":{"website":"https://nomos.energy","linkedin":"https://www.linkedin.com/company/nomos-energy"}},"fonts":{"family":"Soehne","source":"https://qnsvr1iaztsgci9a.public.blob.vercel-storage.com/soehne-buch-d177Pah3KmnkO2UpYz4Ru0Yx4QcPU8.woff2","format":"woff2"},"contextual":{"options":["copy","view","claude","chatgpt","cursor",{"title":"Get Support","description":"Email our team about this page","icon":"life-ring","href":{"base":"mailto:support@nomos.energy","query":[{"key":"subject","value":"Docs question"},{"key":"body","value":"Page: $path\n\n"}]}}],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"riverslate","hasAudioNarration":false,"actualSubdomain":"riverslate","customDomains":["docs.nomos.energy"],"gitSource":{"type":"github","owner":"nomos-energy","repo":"monorepo","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6afb21d914079de35bcd9fab","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"API Reference","count":411},{"language":"default","tag":"Subscriptions","count":29},{"language":"default","tag":"Webhooks","count":23},{"language":"default","tag":"Invoices","count":23},{"language":"default","tag":"Usage","count":22},{"language":"default","tag":"Leads","count":20},{"language":"default","tag":"Plans","count":20},{"language":"default","tag":"Authentication","count":18},{"language":"default","tag":"Documentation","count":16},{"language":"default","tag":"Assets","count":16}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".light .navbar-link a,.light #search-bar-entry,.light #assistant-entry,.light button[aria-label=\"Toggle dark mode\"]{background-color:#ebe8e3!important}.light .navbar-link a:hover,.light #search-bar-entry:hover,.light #assistant-entry:hover,.light button[aria-label=\"Toggle dark mode\"]:hover{background-color:#e2ded9!important}.light #navbar>div.bg-background-light{background-color:#fdfbfa}.dark #navbar>div.bg-background-light{background-color:#000000}.dark #background-color{background-color:#0a0a0a}.light #pagination>a{background-color:#fdfbfa}.dark #pagination>a{background-color:#21262c}.light #page-context-menu button,.light [role=\"menu\"][aria-labelledby^=\"page-context-menu\"]{background-color:#fdfbfa}.dark #page-context-menu button,.dark [role=\"menu\"][aria-labelledby^=\"page-context-menu\"]{background-color:#21262c}#page-context-menu-button span{display:none}#page-context-menu{min-width:0;align-items:stretch}body:has(.is-home-page) #page-context-menu{display:none!important}body:has(.is-home-page) #pagination{display:none!important}.light details.expandable{background-color:#fdfbfa}.light div.bg-background-light:has(>div>.tryit-button){background-color:#fdfbfa}.light [data-component-part=\"version-select-content\"]{background-color:#fdfbfa}.light details.accordion{background-color:#fdfbfa}td code,th code{white-space:nowrap}.light .card{background-color:#fdfbfa}@font-face{font-family:\"Soehne\";src:url(\"/fonts/soehne-kraftig.woff2\") format(\"woff2\");font-weight:500 700;font-style:normal;font-display:swap}#navbar img[src*=\"logo\"],#navbar img[alt=\"light logo\"],#navbar img[alt=\"dark logo\"]{height:1.25rem;width:auto}h1,h2,h3,h4{font-weight:500!important}#navbar nav ul li a,.nav-tabs-item{font-weight:400!important}.nav-tabs-item{text-shadow:none!important}"}],"page":{"pagePath":"api-reference-2026-11-16-faraday/leads/retrieve-a-lead","slug":"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead","pageMetadata":{"title":"Retrieve a lead","description":"Retrieve lead details by its id","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /leads/{id}","href":"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Retrieve lead details by its id\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Retrieve a lead","description":"Retrieve lead details by its id","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /leads/{id}","href":"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Leads"],"summary":"Retrieve a lead","description":"Retrieve lead details by its id","security":["91975dd5-c0a4-4a18-95e0-50679a9309c0"],"parameters":["d3376958-af3e-4f57-94b1-72fc202add0f"],"responses":{"200":"cadeab71-d514-4d51-89eb-12a3078837b5","400":"c592d5e6-dd15-4ed8-b03e-97ce3d4eb02f","401":"a2115692-b18c-4512-a1ab-9a36e34f8cc4","403":"c7c6e4b1-ddda-4aba-8ee3-fbfea67e8f6b","404":"ce49e8ab-61c8-4f27-938d-d4d4a4bf99d8","500":"d711f775-2b70-4d9f-9375-7c87919199b0"},"method":"get","type":"path","servers":["48a6c76e-7ed6-484d-b663-3a64258f0355"],"path":"/leads/{id}","baseUrlOptions":["https://api.nomos.energy"],"title":"Retrieve a lead","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d3376958-af3e-4f57-94b1-72fc202add0f":{"schema":{"type":"string","example":"lead_mi4f0oda6x9m7gcsvjk0ole1","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"id","in":"path"}},"responses":{"cadeab71-d514-4d51-89eb-12a3078837b5":{"description":"Retrieve the lead details","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string","enum":["lead"],"isRequired":true,"uniqueKey":"object","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"Unique identifier for the lead","example":"lead_a8n8ol7yd4h0wohx824f0bui","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"link":{"type":"string","description":"URL of the lead","example":"https://nomos.checkout.energy?id=lead_a8n8ol7yd4h0wohx824f0bui","isRequired":true,"uniqueKey":"link","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","description":"Timestamp when the lead was created","example":"2024-03-14T12:00:00Z","isRequired":true,"uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"string","description":"Timestamp when the lead was created","format":"date-time","example":"2024-03-14T12:00:00Z","isRequired":true,"uniqueKey":"created_at.oneOf.1","typeLabel":"string\u003cdate-time>"}],"isRequired":true,"uniqueKey":"created_at","typeLabel":"string | string\u003cdate-time>"},"subscription":{"oneOf":[{"type":"string","description":"ID of the subscription, if the lead is converted to a subscription","example":"sub_a8n8ol7yd4h0wohx824f0bui","uniqueKey":"subscription.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the subscription, if the lead is converted to a subscription","example":"sub_a8n8ol7yd4h0wohx824f0bui","uniqueKey":"subscription.oneOf.1","typeLabel":"null"}],"uniqueKey":"subscription","typeLabel":"string | null"},"subscribed_at":{"oneOf":[{"type":"string","description":"Timestamp when the lead was converted to a subscription","example":"2024-03-14T12:00:00Z","uniqueKey":"subscribed_at.oneOf.0","typeLabel":"string"},{"type":"string","description":"Timestamp when the lead was converted to a subscription","format":"date-time","example":"2024-03-14T12:00:00Z","uniqueKey":"subscribed_at.oneOf.1","typeLabel":"string\u003cdate-time>"},{"description":"Timestamp when the lead was converted to a subscription","example":"2024-03-14T12:00:00Z","uniqueKey":"subscribed_at.oneOf.2","typeLabel":"any"},{"type":"null","description":"Timestamp when the lead was converted to a subscription","example":"2024-03-14T12:00:00Z","uniqueKey":"subscribed_at.oneOf.3","typeLabel":"null"}],"uniqueKey":"subscribed_at","typeLabel":"string | string\u003cdate-time> | any | null"},"created_by":{"oneOf":[{"type":"string","description":"Email of the user who created the lead","example":"john.doe@example.com","uniqueKey":"created_by.oneOf.0","typeLabel":"string"},{"type":"null","description":"Email of the user who created the lead","example":"john.doe@example.com","uniqueKey":"created_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_by","typeLabel":"string | null"},"last_visited_at":{"oneOf":[{"type":"string","description":"Timestamp when the lead was last visited","example":"2024-03-14T12:00:00Z","uniqueKey":"last_visited_at.oneOf.0","typeLabel":"string"},{"type":"string","description":"Timestamp when the lead was last visited","format":"date-time","example":"2024-03-14T12:00:00Z","uniqueKey":"last_visited_at.oneOf.1","typeLabel":"string\u003cdate-time>"},{"description":"Timestamp when the lead was last visited","example":"2024-03-14T12:00:00Z","uniqueKey":"last_visited_at.oneOf.2","typeLabel":"any"},{"type":"null","description":"Timestamp when the lead was last visited","example":"2024-03-14T12:00:00Z","uniqueKey":"last_visited_at.oneOf.3","typeLabel":"null"}],"uniqueKey":"last_visited_at","typeLabel":"string | string\u003cdate-time> | any | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"null"},"description":"Metadata of the lead, can be internal data","example":{"utm_source":"google","utm_campaign":"campaign_name","user_id":"1234567890"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"oneOf":[{},{"type":"null","uniqueKey":"metadata.oneOf.1.additionalProperties.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"null"},"description":"Metadata of the lead, can be internal data","example":{"utm_source":"google","utm_campaign":"campaign_name","user_id":"1234567890"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"}},"required":["object","id","link","created_at"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"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"}}}},"exampleType":"generated"}},"exampleType":"generated"},"c592d5e6-dd15-4ed8-b03e-97ce3d4eb02f":{"description":"The request is invalid: a field fails validation, breaks a business rule, or the body is not valid JSON. `errors` lists every problem with its field.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["BAD_REQUEST"],"description":"The error code related to the status code.","example":"BAD_REQUEST","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable message describing the issue.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"The request id to be used for debugging and error reporting.","example":"37a04f8f-e791-491c-81e1-86cd304649bb","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"The docs related to the error code.","example":"https://docs.nomos.energy/api-references/errors/BAD_REQUEST","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"What is wrong with the field, such as `invalid_type` or `asset_not_found`. `x-extensible-enum` lists the values known today. New values can be added in any API version, so treat an unknown value like any other error of the response's status.","example":"invalid_type","x-extensible-enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","unserviceable_zip","ended_subscription","duplicate_grid_reduction","missing_smart_meter","missing_module_1","incompatible_grid_reduction","unsupported_product","unsupported_meter_order","duplicate_meter_order","unsupported_meter","out_of_period_meter_reading","unsupported_meter_reading","duplicate_meter_reading","implausible_meter_reading","duplicate_customer_email","invalid_iban","upgrade_api_version","withdrawal_not_allowed","invalid_termination_date","subscription_not_started","terminated_subscription","missing_household","invalid_household_customer","invalid_household_meter","duplicate_consumption_subscription","invalid_inverter","read_only_asset","duplicate_external_id","asset_has_children","asset_decommissioned","asset_not_found","mixed_households","field_not_allowed","invalid_direction","duplicate_timestamp","asset_not_steerable","mode_not_allowed","slot_missing"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","example":"customer.email","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"Invalid input: expected string, received undefined","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message","requestId","docs"],"uniqueKey":"","typeLabel":"object"},"examples":{"Unsupported version header":{"title":"Unsupported version header","summary":"Unsupported version header","value":{"code":"BAD_REQUEST","message":"Version header 2026-01-01.foo is invalid.","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/BAD_REQUEST"}}},"exampleType":"examples"}},"exampleType":"examples"},"a2115692-b18c-4512-a1ab-9a36e34f8cc4":{"description":"The access token is missing, expired or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["UNAUTHORIZED"],"description":"The error code related to the status code.","example":"UNAUTHORIZED","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable message describing the issue.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"The request id to be used for debugging and error reporting.","example":"37a04f8f-e791-491c-81e1-86cd304649bb","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"The docs related to the error code.","example":"https://docs.nomos.energy/api-references/errors/UNAUTHORIZED","isRequired":true,"uniqueKey":"docs","typeLabel":"string"}},"required":["code","message","requestId","docs"],"uniqueKey":"","typeLabel":"object"},"examples":{"No token":{"title":"No token","summary":"No token","value":{"code":"UNAUTHORIZED","message":"No authorization header provided.","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/UNAUTHORIZED"}},"Expired token":{"title":"Expired token","summary":"Expired token","value":{"code":"UNAUTHORIZED","message":"Token expired","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/UNAUTHORIZED"}},"Invalid token":{"title":"Invalid token","summary":"Invalid token","value":{"code":"UNAUTHORIZED","message":"Invalid or malformed token","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/UNAUTHORIZED"}}},"exampleType":"examples"}},"exampleType":"examples"},"c7c6e4b1-ddda-4aba-8ee3-fbfea67e8f6b":{"description":"The access token is valid but not allowed to use this endpoint.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["FORBIDDEN"],"description":"The error code related to the status code.","example":"FORBIDDEN","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable message describing the issue.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"The request id to be used for debugging and error reporting.","example":"37a04f8f-e791-491c-81e1-86cd304649bb","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"The docs related to the error code.","example":"https://docs.nomos.energy/api-references/errors/FORBIDDEN","isRequired":true,"uniqueKey":"docs","typeLabel":"string"}},"required":["code","message","requestId","docs"],"uniqueKey":"","typeLabel":"object"},"examples":{"Role without access":{"title":"Role without access","summary":"Role without access","value":{"code":"FORBIDDEN","message":"Forbidden to access this route.","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/FORBIDDEN"}},"Token without scope":{"title":"Token without scope","summary":"Token without scope","value":{"code":"FORBIDDEN","message":"Insufficient scope: read:* required.","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/FORBIDDEN"}},"Customer token without customer":{"title":"Customer token without customer","summary":"Customer token without customer","value":{"code":"FORBIDDEN","message":"Customer not found.","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/FORBIDDEN"}}},"exampleType":"examples"}},"exampleType":"examples"},"ce49e8ab-61c8-4f27-938d-d4d4a4bf99d8":{"description":"A resource in the path or the body does not exist or belongs to another organization, or the endpoint does not exist in the API version of your token.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["NOT_FOUND"],"description":"The error code related to the status code.","example":"NOT_FOUND","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable message describing the issue.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"The request id to be used for debugging and error reporting.","example":"37a04f8f-e791-491c-81e1-86cd304649bb","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"The docs related to the error code.","example":"https://docs.nomos.energy/api-references/errors/NOT_FOUND","isRequired":true,"uniqueKey":"docs","typeLabel":"string"},"errors":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"What is wrong with the field, such as `invalid_type` or `asset_not_found`. `x-extensible-enum` lists the values known today. New values can be added in any API version, so treat an unknown value like any other error of the response's status.","example":"invalid_type","x-extensible-enum":["invalid_type","too_big","too_small","invalid_format","not_multiple_of","unrecognized_keys","invalid_union","invalid_key","invalid_element","invalid_value","custom","unserviceable_zip","ended_subscription","duplicate_grid_reduction","missing_smart_meter","missing_module_1","incompatible_grid_reduction","unsupported_product","unsupported_meter_order","duplicate_meter_order","unsupported_meter","out_of_period_meter_reading","unsupported_meter_reading","duplicate_meter_reading","implausible_meter_reading","duplicate_customer_email","invalid_iban","upgrade_api_version","withdrawal_not_allowed","invalid_termination_date","subscription_not_started","terminated_subscription","missing_household","invalid_household_customer","invalid_household_meter","duplicate_consumption_subscription","invalid_inverter","read_only_asset","duplicate_external_id","asset_has_children","asset_decommissioned","asset_not_found","mixed_households","field_not_allowed","invalid_direction","duplicate_timestamp","asset_not_steerable","mode_not_allowed","slot_missing"],"isRequired":true,"uniqueKey":"errors.items.[INDEX].code","typeLabel":"string"},"field":{"type":"string","example":"customer.email","isRequired":true,"uniqueKey":"errors.items.[INDEX].field","typeLabel":"string"},"message":{"type":"string","example":"Invalid input: expected string, received undefined","isRequired":true,"uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"}},"required":["code","field","message"],"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"description":"Per-field breakdown of a validation or business-rule failure. Omitted for API versions before the structured-errors cutoff.","uniqueKey":"errors","typeLabel":"object[]"}},"required":["code","message","requestId","docs"],"uniqueKey":"","typeLabel":"object"},"examples":{"Unknown lead":{"title":"Unknown lead","summary":"Unknown lead","value":{"code":"NOT_FOUND","message":"Lead not found","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/NOT_FOUND"}},"Endpoint not in your API version":{"title":"Endpoint not in your API version","summary":"Endpoint not in your API version","value":{"code":"NOT_FOUND","message":"There is no GET /leads/{id} in API version 2025-12-01.chucky.","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/NOT_FOUND"}}},"exampleType":"examples"}},"exampleType":"examples"},"d711f775-2b70-4d9f-9375-7c87919199b0":{"description":"Something went wrong on our side. Retry later, and send us the `requestId` if it persists.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"string","enum":["INTERNAL_SERVER_ERROR"],"description":"The error code related to the status code.","example":"INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A human readable message describing the issue.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"requestId":{"type":"string","description":"The request id to be used for debugging and error reporting.","example":"37a04f8f-e791-491c-81e1-86cd304649bb","isRequired":true,"uniqueKey":"requestId","typeLabel":"string"},"docs":{"type":"string","description":"The docs related to the error code.","example":"https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR","isRequired":true,"uniqueKey":"docs","typeLabel":"string"}},"required":["code","message","requestId","docs"],"uniqueKey":"","typeLabel":"object"},"examples":{"Unexpected error":{"title":"Unexpected error","summary":"Unexpected error","value":{"code":"INTERNAL_SERVER_ERROR","message":"Internal Server Error","requestId":"37a04f8f-e791-491c-81e1-86cd304649bb","docs":"https://docs.nomos.energy/api-references/errors/INTERNAL_SERVER_ERROR"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"91975dd5-c0a4-4a18-95e0-50679a9309c0":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"}}},"servers":{"48a6c76e-7ed6-484d-b663-3a64258f0355":{"url":"https://api.nomos.energy","description":"production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi/openapi.faraday.json"},"subdomain":"riverslate","siteName":"Nomos","title":"Retrieve a lead - Nomos","navMaps":{"firstHrefInVersion":{"2026-11-16.faraday (preview)":{"href":"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead","matchLevel":0},"2026-09-08.gauss":{"href":"/api-reference/leads/retrieve-a-lead","matchLevel":1},"2026-05-27.curie":{"href":"/api-reference-2026-05-27-curie/leads/retrieve-a-lead","matchLevel":1},"2026-01-29.edison":{"href":"/api-reference-2026-01-29-edison/leads/retrieve-a-lead","matchLevel":1},"2025-12-16.batman":{"href":"/api-reference-2025-12-16-batman/leads/retrieve-a-lead","matchLevel":1},"2025-12-01.chucky":{"href":"/api-reference-2025-12-01-chucky/leads/retrieve-a-lead","matchLevel":1}},"firstHrefInLanguage":{}},"lastModified":"2026-11-16T15:31:49.342Z","originalFileLocation":"api-reference-2026-11-16-faraday/leads/retrieve-a-lead.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Retrieve lead details by its id\">\u003cmeta data-mint-head name=\"application-name\" content=\"Nomos\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve a lead - Nomos\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve lead details by its id\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Nomos\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://riverslate.mintlify.site/_mintlify/api/og/v2?division=Leads\u0026amp;title=Retrieve+a+lead\u0026amp;description=Retrieve+lead+details+by+its+id\u0026amp;theme=9f06b09645d9ae8ac0235d4f\u0026amp;signature=4ae34789985e3ba112a8ae64539000f97ca1f42fded356817b344cebda7f9868\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Retrieve a lead - Nomos\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve lead details by its id\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://riverslate.mintlify.site/_mintlify/api/og/v2?division=Leads\u0026amp;title=Retrieve+a+lead\u0026amp;description=Retrieve+lead+details+by+its+id\u0026amp;theme=9f06b09645d9ae8ac0235d4f\u0026amp;signature=4ae34789985e3ba112a8ae64539000f97ca1f42fded356817b344cebda7f9868\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/riverslate/iILQM7kXCjcV9kRT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Nomos\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1b1915\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.nomos.energy/#organization\",\"name\":\"Nomos\",\"url\":\"https://docs.nomos.energy\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/riverslate/0nQqndf6SGR4MtUC/logo/light.svg?fit=max\u0026auto=format\u0026n=0nQqndf6SGR4MtUC\u0026q=85\u0026s=99c5d32286bf07989f99539ad1584d34\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.nomos.energy#website\",\"name\":\"Nomos\",\"url\":\"https://docs.nomos.energy\",\"publisher\":{\"@id\":\"https://docs.nomos.energy/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead#webpage\",\"url\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead\",\"name\":\"Retrieve a lead\",\"description\":\"Retrieve lead details by its id\",\"dateModified\":\"2026-11-16T15:31:49.342Z\",\"isPartOf\":{\"@id\":\"https://docs.nomos.energy#website\"},\"breadcrumb\":{\"@id\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/plans/calculate-a-quote\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve a lead\",\"item\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead#apireference\",\"headline\":\"Retrieve a lead\",\"name\":\"Retrieve a lead\",\"description\":\"Retrieve lead details by its id\",\"url\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead\",\"mainEntityOfPage\":{\"@id\":\"https://docs.nomos.energy/api-reference-2026-11-16-faraday/leads/retrieve-a-lead#webpage\"},\"dateModified\":\"2026-11-16T15:31:49.342Z\",\"publisher\":{\"@id\":\"https://docs.nomos.energy/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.nomos.energy#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Nomos\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Nomos\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead.md","siteName":"Nomos","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/home"}]},{"tab":"API Reference","icon":"code","versions":[{"version":"2026-11-16.faraday (preview)","groups":[{"group":" ","pages":[{"title":"API Reference","sidebarTitle":"Introduction","href":"/api-references/introduction"},{"title":"Authentication","href":"/api-references/authentication"},{"title":"Versioning","href":"/api-references/versioning"},{"title":"Pagination","href":"/api-references/pagination"},{"title":"Filtering","href":"/api-references/filtering"},{"title":"Errors","href":"/api-references/errors"},{"title":"Changelog","href":"/api-references/changelog"}]},{"group":"API Reference","pages":[{"group":"Plans","pages":[{"title":"Calculate a quote","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /plans/{id}/quote","href":"/api-reference-2026-11-16-faraday/plans/calculate-a-quote"},{"title":"Calculate savings","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /plans/{id}/savings","href":"/api-reference-2026-11-16-faraday/plans/calculate-savings"},{"title":"List plans","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /plans","href":"/api-reference-2026-11-16-faraday/plans/list-plans"},{"title":"Retrieve a plan","description":"Retrieve a plan details by its id","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /plans/{id}","href":"/api-reference-2026-11-16-faraday/plans/retrieve-a-plan"}]},{"group":"Leads","pages":[{"title":"Retrieve a lead","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /leads/{id}","href":"/api-reference-2026-11-16-faraday/leads/retrieve-a-lead"},{"title":"Update a lead","description":"Update the editable fields of a lead. Send only the fields that change. `metadata` is merged key-by-key onto the stored object (a key set to `null` is removed; `metadata: null` clears every key). The request body must be JSON without repeated keys, and any unknown field is rejected with `400 BAD_REQUEST`.","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json patch /leads/{id}","href":"/api-reference-2026-11-16-faraday/leads/update-a-lead"},{"title":"List leads","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /leads","href":"/api-reference-2026-11-16-faraday/leads/list-leads"},{"title":"Create a lead","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /leads","href":"/api-reference-2026-11-16-faraday/leads/create-a-lead"}]},{"group":"Subscriptions","pages":[{"title":"Retrieve a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /subscriptions/{id}","href":"/api-reference-2026-11-16-faraday/subscriptions/retrieve-a-subscription"},{"title":"Update a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json patch /subscriptions/{id}","href":"/api-reference-2026-11-16-faraday/subscriptions/update-a-subscription"},{"title":"Terminate a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /subscriptions/{id}/terminate","href":"/api-reference-2026-11-16-faraday/subscriptions/terminate-a-subscription"},{"title":"List subscriptions","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /subscriptions","href":"/api-reference-2026-11-16-faraday/subscriptions/list-subscriptions"},{"title":"Create a subscription","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /subscriptions","href":"/api-reference-2026-11-16-faraday/subscriptions/create-a-subscription"}]},{"group":"Customers","pages":[{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /customers/{id}","href":"/api-reference-2026-11-16-faraday/customers/retrieve-a-customer"},{"title":"Update a customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json patch /customers/{id}","href":"/api-reference-2026-11-16-faraday/customers/update-a-customer"},{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /customers","href":"/api-reference-2026-11-16-faraday/customers/list-customers"}]},{"group":"Households","pages":[{"title":"List households","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /households","href":"/api-reference-2026-11-16-faraday/households/list-households"},{"title":"Retrieve a household","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /households/{id}","href":"/api-reference-2026-11-16-faraday/households/retrieve-a-household"}]},{"group":"Assets","pages":[{"title":"List assets","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /assets","href":"/api-reference-2026-11-16-faraday/assets/list-assets"},{"title":"Add an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /assets","href":"/api-reference-2026-11-16-faraday/assets/add-an-asset"},{"title":"Retrieve an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /assets/{id}","href":"/api-reference-2026-11-16-faraday/assets/retrieve-an-asset"},{"title":"Update an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json patch /assets/{id}","href":"/api-reference-2026-11-16-faraday/assets/update-an-asset"},{"title":"Decommission an asset","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /assets/{id}/decommission","href":"/api-reference-2026-11-16-faraday/assets/decommission-an-asset"},{"title":"List the newest asset snapshots","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /asset-snapshots","href":"/api-reference-2026-11-16-faraday/assets/list-the-newest-asset-snapshots"},{"title":"Send asset snapshots","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /asset-snapshots","href":"/api-reference-2026-11-16-faraday/assets/send-asset-snapshots"},{"title":"Retrieve an asset schedule","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /assets/{id}/schedule","href":"/api-reference-2026-11-16-faraday/assets/retrieve-an-asset-schedule"}]},{"group":"Usage","pages":[{"title":"Retrieve usage data","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /subscriptions/{id}/usage","href":"/api-reference-2026-11-16-faraday/usage/retrieve-usage-data"},{"title":"List meter readings","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /meter-readings","href":"/api-reference-2026-11-16-faraday/usage/list-meter-readings"},{"title":"Create a meter reading","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /meter-readings","href":"/api-reference-2026-11-16-faraday/usage/create-a-meter-reading"}]},{"group":"Prices","pages":[{"title":"Retrieve a subscription price time series","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /subscriptions/{id}/prices","href":"/api-reference-2026-11-16-faraday/prices/retrieve-a-subscription-price-time-series"}]},{"group":"Invoices","pages":[{"title":"Retrieve an invoice","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /invoices/{id}","href":"/api-reference-2026-11-16-faraday/invoices/retrieve-an-invoice"},{"title":"List invoices","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /invoices","href":"/api-reference-2026-11-16-faraday/invoices/list-invoices"},{"title":"Retrieve an invoice PDF","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /invoices/{id}/file","href":"/api-reference-2026-11-16-faraday/invoices/retrieve-an-invoice-pdf"}]},{"group":"Smart Meter Orders","pages":[{"title":"Retrieve a smart meter order","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /meter-orders/{id}","href":"/api-reference-2026-11-16-faraday/smart-meter-orders/retrieve-a-smart-meter-order"},{"title":"List smart meter orders","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /meter-orders","href":"/api-reference-2026-11-16-faraday/smart-meter-orders/list-smart-meter-orders"},{"title":"Create a smart meter order","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /meter-orders","href":"/api-reference-2026-11-16-faraday/smart-meter-orders/create-a-smart-meter-order"}]},{"group":"Grid Fee Reductions","pages":[{"title":"List grid fee reductions","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /grid-fee-reductions","href":"/api-reference-2026-11-16-faraday/grid-fee-reductions/list-grid-fee-reductions"},{"title":"Create a grid fee reduction","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /grid-fee-reductions","href":"/api-reference-2026-11-16-faraday/grid-fee-reductions/create-a-grid-fee-reduction"},{"title":"Retrieve a grid fee reduction","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /grid-fee-reductions/{id}","href":"/api-reference-2026-11-16-faraday/grid-fee-reductions/retrieve-a-grid-fee-reduction"}]},{"group":"Market Partners","pages":[{"title":"List market partners","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /market-partners","href":"/api-reference-2026-11-16-faraday/market-partners/list-market-partners"}]},{"group":"Events","pages":[{"title":"Retrieve an event","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /events/{id}","href":"/api-reference-2026-11-16-faraday/events/retrieve-an-event"}]},{"group":"Authentication","pages":[{"title":"Create a token","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /oauth/token","href":"/api-reference-2026-11-16-faraday/authentication/create-a-token"},{"title":"Authorize","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json get /oauth/authorize","href":"/api-reference-2026-11-16-faraday/authentication/authorize"},{"title":"Create a magic link (customer portal)","deprecated":null,"version":null,"openapi":"/openapi/openapi.faraday.json post /admin/magic_link","href":"/api-reference-2026-11-16-faraday/authentication/create-a-magic-link-customer-portal"}]}]}]},{"version":"2026-09-08.gauss","default":true,"pages":[{"title":"2026-09-08.gauss","href":"/api-reference/leads/retrieve-a-lead"}]},{"version":"2026-05-27.curie","pages":[{"title":"2026-05-27.curie","href":"/api-reference-2026-05-27-curie/leads/retrieve-a-lead"}]},{"version":"2026-01-29.edison","pages":[{"title":"2026-01-29.edison","href":"/api-reference-2026-01-29-edison/leads/retrieve-a-lead"}]},{"version":"2025-12-16.batman","pages":[{"title":"2025-12-16.batman","href":"/api-reference-2025-12-16-batman/leads/retrieve-a-lead"}]},{"version":"2025-12-01.chucky","pages":[{"title":"2025-12-01.chucky","href":"/api-reference-2025-12-01-chucky/leads/retrieve-a-lead"}]}]},{"tab":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/webhooks/introduction"}]}]},"basePath":"","title":"Retrieve a lead - Nomos","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}