Retrieve one lead with its event details, pricing, rentals, status and customer. Notice that the Lead ID is passed into the GET URL.
| Method | URL | API key permission | Package |
|---|---|---|---|
| GET | https://rental.software/api6/leads/{lead_id} | Leads: Read Only or Full Access | WP/API |
Request
GET /api6/leads/520247?apiKey=YOUR_API_KEY&_body=true
| Parameter | Where | Required | Description |
|---|---|---|---|
| lead_id | URL path | Yes | Numeric ID of the lead |
| apiKey | Query string | Yes | Your API key |
| _body | Query string | No | If true, returns more details: the worker shifts, the file attachments, and a full record for each rental on the lead in rentals |
Example using curl:
curl "https://rental.software/api6/leads/520247?apiKey=YOUR_API_KEY&_body=true"
Response
{
"id": "520247",
"createtime": "2025-05-28T11:33:30-04:00",
"modifiedtime": "2025-10-27T15:45:16-04:00",
"eventname": "Test Event 2",
"eventorganization": "Big Company",
"eventstreet": "123 Main St",
"eventcity": "Akron",
"eventstate": "OH",
"eventzip": "44301",
"eventstarttime": "2026-07-15T16:00:00-04:00",
"eventduration": "2.00",
"deliverytype": "Fully Staffed",
"surface": "Grass",
"taxexempt": "No",
"holdtime": "",
"eventcountry": "",
"eventcounty": "Summit",
"selectedrides": [
"4",
"15"
],
"rentalqty": {
"4": "1"
},
"contactid": "533268",
"ridequotes": {
"4": "200.00"
},
"cpdiscount": "0.00",
"taxrate": "7.000",
"staffcost": "40.00",
"distcharge": "7.83",
"salestax": "27.30",
"total": "425.13",
"coupon": "0",
"fee": "0.00",
"notes": "",
"status": {
"id": "2349",
"name": "Hold",
"isactive": "1",
"order": "6",
"color": "3399FF",
"newlead": "0",
"newquote": "0",
"contract": "0",
"confirmed": "0",
"complete": "0",
"cancel": "0",
"postpone": "0"
},
"statusid": "2349",
"viewed": "Yes",
"fullstart": "2026-07-15T16:00:00-04:00",
"fullend": "2026-07-15T18:00:00-04:00",
"cushstart": "2026-07-15T08:00:00-04:00",
"cushend": "2026-07-16T02:00:00-04:00",
"adjust": "0.00",
"depositamount": "",
"amountpaid": "",
"numguests": "",
"referral": "Bing",
"locationid": "0",
"salesrep": "0",
"venueid": "16839",
"venuecontact": "",
"additionalnotes1": "",
"additionalnotes2": "",
"eventendtime": "2026-07-15T18:00:00-04:00",
"subtotal": 397.83,
"optionparent": {
"4": [
"15"
]
},
"rentalstarttime": {
"4": "1784145600",
"15": "1784145600"
},
"rentalendtime": {
"4": "1784152800",
"15": "1784152800"
},
"isoption": [
0,
1
],
"leadrental_conflict": {
"4": "none",
"15": "none"
},
"rentalqty_option": {
"4": {
"15": "1"
}
},
"ridequotes_option": {
"4": {
"15": "150.00"
}
},
"venuename": "",
"venuenotes": "",
"cust": {
"id": "533268",
"createtime": "2025-05-12T11:21:30-04:00",
"modifiedtime": "2025-10-27T15:46:21-04:00",
"organization": "",
"firstname": "Jordan",
"lastname": "Rivera",
"street": "123 Main St",
"city": "Akron",
"state": "OH",
"zip": "44301",
"country": "",
"homephone": "(330) 555-0142",
"officephone": "(330) 555-0143",
"cellphone": "(330) 555-0144",
"fax": "",
"email": "jordan.rivera@example.com",
"notes": "",
"customertype": "Commercial",
"locationid": "0",
"tags": [],
"href": "https://rental.software/api6/customers/533268",
"createtime_ts": "1747063290",
"createtime_utc": "2025-05-12T15:21:30Z",
"modifiedtime_ts": "1761594381",
"modifiedtime_utc": "2025-10-27T19:46:21Z"
},
"customfields_ids": {
"35860": {
"name": "Party Theme",
"value": "Blue balloons",
"type": "smalltext",
"options": null
}
},
"shifts": [
{
"id": "227051",
"modifiedtime": "2026-04-27T16:37:59-04:00",
"quoteid": "520247",
"workerid": "2",
"position": "",
"starttime": "2026-07-15T14:30:00-04:00",
"endtime": "2026-07-15T18:30:00-04:00",
"positionid": "4",
"workerresponse": ""
}
],
"href": "https://rental.software/api6/leads/520247",
"createtime_ts": "1748446410",
"createtime_utc": "2025-05-28T15:33:30Z",
"modifiedtime_ts": "1761594316",
"modifiedtime_utc": "2025-10-27T19:45:16Z",
"eventstarttime_ts": "1784145600",
"eventstarttime_utc": "2026-07-15T20:00:00Z",
"fullstart_ts": "1784145600",
"fullstart_utc": "2026-07-15T20:00:00Z",
"fullend_ts": "1784152800",
"fullend_utc": "2026-07-15T22:00:00Z",
"cushstart_ts": "1784116800",
"cushstart_utc": "2026-07-15T12:00:00Z",
"cushend_ts": "1784181600",
"cushend_utc": "2026-07-16T06:00:00Z",
"eventendtime_ts": 1784152800,
"eventendtime_utc": "2026-07-15T22:00:00Z",
"request_time": 1760000000
}
The example is shortened. A lead contains more fields than shown here, and your code should ignore fields it does not use.
How to Read the Response
| Field | Description |
|---|---|
| selectedrides | The IDs of every rental and option on the lead |
| rentalqty, ridequotes | Quantity and price of each main rental, keyed by Rental ID |
| optionparent | Which options belong to which rental. In the example, option 15 belongs to rental 4 |
| rentalqty_option, ridequotes_option | Quantity and price of each option, keyed by the parent Rental ID and then the option ID |
| rentalstarttime, rentalendtime | Start and end of each rental as Unix timestamps |
| status, statusid | The lead status. status holds the full status record, including flags such as confirmed, complete and cancel |
| cust, contactid | The customer on the lead |
| customfields_ids | Lead custom fields, keyed by custom field ID |
| subtotal, salestax, total | Pricing totals |
| fullstart, fullend | When the rentals are first and last tied up by the lead: the event plus delivery or setup, tear down and travel time. Availability is checked against these |
| cushstart, cushend | Start and end including the cushion time around the event |
| setupwindowstart, setupwindowend | Delivery window. Returned the same three ways as the other date fields, plus a _formatted version |
| tdownwindowstart, tdownwindowend | Return window as Unix timestamps |
| setupstart, tdownstart | Planned delivery and pickup start as Unix timestamps, when set |
| setupduration, tdownduration, ttimefrom | Setup time, tear down time and travel time each way, in hours |
| shifts, attachments, rentals | Only returned with _body=true |
| href | URL of this lead in the API |
Date fields come three ways: the plain field in your account's time zone (eventstarttime), a Unix timestamp (eventstarttime_ts), and UTC (eventstarttime_utc).
To change the delivery and return times (setupwindowstart through ttimefrom above), send them to API - Leads - Create or Update together with save_time_fields set to 1. Without it they are ignored, so sending a retrieved lead back unchanged does not change its times.
Errors
| Status | Message | What to do |
|---|---|---|
| 403 | Permission access restricted | Give the API key Leads access under Settings > API Keys |
| 403 | Location access restricted | The lead belongs to a location the key cannot access |
| 404 | Lead not found | No lead with that ID exists in your account |
See API - Errors and Rate Limits for errors that apply to every call.