Get Lead Status

GET/api/v1/public/leads/{external_id}/

Used to get the current status and order number of a created lead.

Auth: Provider API Key (Bearer).

:::info Scoping You can only see the leads you created. Accessing another provider's lead returns 403 or 404. :::

Path parameter

Parameter	Type	Description
external_id	String	The unique ID sent at creation time

Response — 200 OK

{
  "id": 1042,
  "order_number": "00001042-XT",
  "state": "LEAD",
  "lead_status": "LEAD",
  "external_id": "lead_998123A"
}

state — lead lifecycle

Value	Meaning
LEAD	Newly created, not yet processed
QUOTE	Turned into a price quote
ORDER	Turned into an order (closed / confirmed)

Code samples

curl

curl https://api.navigo.example/api/v1/public/leads/lead_998123A/ \
  -H "Authorization: Bearer $NAVIGO_API_KEY"

JavaScript

const res = await fetch(
  "https://api.navigo.example/api/v1/public/leads/lead_998123A/",
  { headers: { Authorization: `Bearer ${process.env.NAVIGO_API_KEY}` } },
);
if (!res.ok) throw new Error(`Status check failed: ${res.status}`);
const lead = await res.json();
console.log(lead.state); // "LEAD" | "QUOTE" | "ORDER"

Python

import os, requests

resp = requests.get(
    "https://api.navigo.example/api/v1/public/leads/lead_998123A/",
    headers={"Authorization": f"Bearer {os.environ['NAVIGO_API_KEY']}"},
    timeout=15,
)
resp.raise_for_status()
lead = resp.json()
print(lead["state"])  # LEAD | QUOTE | ORDER

Possible errors

Status	Reason
404	No lead with this external_id
403 / 404	Attempt to access another provider's lead
401	API key is invalid

Full format: Errors.