Skip to main content
GET
/
leads
/
{id}
Retrieve a Lead
curl --request GET \
  --url https://commerce.driv.ly/api/leads/{id}
{
  "data": {
    "id": "<string>",
    "phoneNumber": "<string>",
    "email": "<string>",
    "salesRep": "<string>",
    "consumer": "<string>",
    "favorites": [
      "<string>"
    ],
    "acceptsGeneratedMessages": true
  },
  "success": true
}

Path Parameters

​
id
string
required

Lead is uniquely identified by id

Query Parameters

​
depth
integer

The number of levels of related objects to include in the response

Response

Lead Found

​
data
Lead · object
Example:
{
  "id": "led_3k2jd9s8v2s4",
  "email": "contact@example.com",
  "salesRep": "SalesRep ID",
  "consumer": "Consumer ID",
  "favorites": ["Vehicle ID Number"],
  "phoneNumber": "555-6789",
  "acceptsGeneratedMessages": true
}
​
success
boolean