Get Lead

Get lead

curl --request GET \
  --url https://api.superiorvan.com/v1/leads/{leadId} \
  --header 'x-api-key: <api-key>'

{
  "leadId": "<string>",
  "status": "In Progress",
  "vendor_requestdate": "2023-12-25"
}

GET

leads

{leadId}

Get lead

curl --request GET \
  --url https://api.superiorvan.com/v1/leads/{leadId} \
  --header 'x-api-key: <api-key>'

{
  "leadId": "<string>",
  "status": "In Progress",
  "vendor_requestdate": "2023-12-25"
}

Retrieve the current status and notes for a submitted lead using the leadId returned from Create Lead.

x-api-key

string

header

required

API key issued to your vendor account

leadId

string

required

Unique lead id returned from the Superior Van API

Lead retrieved

leadId

string

Unique lead id from Superior Van

status

enum<string>

Current processing status of the lead

Available options:

In Progress,

Won,

Lost

vendor_requestdate

string<date>

Date the lead was submitted (YYYY-MM-DD format)

⌘I