Leads
Use the REST API to interact with Leads
List leads
Retrieve a list of leads
Authorizations
Header parameters
AcceptstringRequiredExample:
Setting to application/json
is recommended
application/json
Responses
200
Success
application/json
401
Unauthorised
application/json
get
GET /public/leads HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
[
{
"id": "751dd3d0-23ae-4a4a-9049-6982423da87a",
"type": "form",
"google_client_id": 123456789.98765433,
"lead_date": "2023-01-01 10:30:00",
"name": "John Smith",
"email": "[email protected]",
"phone": "0411 111 111",
"message": "I'm looking for a price for a car service",
"web_source": "google",
"web_campaign": "Location Based",
"web_medium": "paid",
"web_keyword": "Sydney Car Service",
"quality_score": 6.5,
"engagement_score": 8,
"form_name": "Contact Us",
"url": "https://www.sydcarservice.xyz/contact-us",
"data": {
"make": "Nissan",
"year": 2022,
"model": "X-Trail"
},
"link": "https://app.engineroom.com.au/leads/751dd3d0-23ae-4a4a-9049-6982423da87a&business=46580dbc-da00-4316-9a2d-c04a133741aa",
"business": {
"id": "46580dbc-da00-4316-9a2d-c04a133741aa",
"name": "XYZ Car Servicing"
}
}
]
Creating a new lead
Get lead
Retrieve a single lead
Authorizations
Path parameters
idstringRequiredExample:
Lead ID
751dd3d0-23ae-4a4a-9049-6982423da87a
Header parameters
AcceptstringRequiredExample:
Setting to application/json
is recommended
application/json
Responses
200
Success
application/json
401
Unauthorised
application/json
get
GET /public/leads/{id} HTTP/1.1
Host: api2.engineroom.com.au
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: application/json
{
"id": "751dd3d0-23ae-4a4a-9049-6982423da87a",
"type": "form",
"google_client_id": 123456789.98765433,
"lead_date": "2023-01-01 10:30:00",
"name": "John Smith",
"email": "[email protected]",
"phone": "0411 111 111",
"message": "I'm looking for a price for a car service",
"web_source": "google",
"web_campaign": "Location Based",
"web_medium": "paid",
"web_keyword": "Sydney Car Service",
"quality_score": 6.5,
"engagement_score": 8,
"form_name": "Contact Us",
"url": "https://www.sydcarservice.xyz/contact-us",
"data": {
"make": "Nissan",
"year": 2022,
"model": "X-Trail"
},
"link": "https://app.engineroom.com.au/leads/751dd3d0-23ae-4a4a-9049-6982423da87a&business=46580dbc-da00-4316-9a2d-c04a133741aa",
"business": {
"id": "46580dbc-da00-4316-9a2d-c04a133741aa",
"name": "XYZ Car Servicing"
}
}
Last updated