Leads

Use the REST API to interact with Leads

List leads

Retrieve leads

Retrieve a list of leads

GEThttps://api2.engineroom.com.au/public/leads

Authorization

bearerAuth

Header parameters

Response

200401

Success

Body

application/json

idstring

Example: "751dd3d0-23ae-4a4a-9049-6982423da87a"

typestring

Example: "form"

google_client_idstring

Example: 123456789.98765433

lead_datestring

Example: "2023-01-01 10:30:00"

namestring

Example: "John Smith"

emailstring

Example: "[e-mail]"

phonestring

Example: "0411 111 111"

messagestring

Example: "I'm looking for a price for a car service"

web_sourcestring

Example: "google"

web_campaignstring

Example: "Location Based"

web_mediumstring

Example: "paid"

web_keywordstring

Example: "Sydney Car Service"

quality_scorestring

Example: 6.5

engagement_scorestring

Example: 8

form_namestring

Example: "Contact Us"

urlstring

Example: "https://www.sydcarservice.xyz/contact-us"

dataobject

linkstring

Example: "https://app.engineroom.com.au/leads/751dd3d0-23ae-4a4a-9049-6982423da87a&business=46580dbc-da00-4316-9a2d-c04a133741aa"

businessobject

Request

JavaScriptCurlPython

const response = await fetch('https://api2.engineroom.com.au/public/leads', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "application/json"
    },
});
const data = await response.json();

Response

200401

[
  {
    "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": "[e-mail]",
    "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

Create a new lead

Create a new lead entry

POSThttps://api2.engineroom.com.au/public/leads

Authorization

bearerAuth

body

Header parameters

Response

201400

Lead created successfully

Body

application/json

messagestring

Example: "Lead created successfully."

dataobject

Request

JavaScriptCurlPython

const response = await fetch('https://api2.engineroom.com.au/public/leads', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "application/json"
    },
});
const data = await response.json();

Response

201

{
  "message": "Lead created successfully.",
  "data": {
    "id": "b0a00e1a-7748-4c68-acd1-36bc74ec0b7b",
    "type": "form",
    "google_client_id": 123456789.98765433,
    "lead_date": "2023-01-30T03:21:49.005548Z",
    "name": "John Smith",
    "email": "[e-mail]",
    "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",
    "url": "https://www.sydcarservice.xyz/contact-us",
    "data": {
      "make": "Nissan",
      "model": "X-Trail",
      "year": "2022"
    },
    "link": "https://app.engineroom.com.au/leads/b0a00e1a-7748-4c68-acd1-36bc74ec0b7b&business=cb50eb42-22b3-4df4-bbcd-efcd9694f3f8\"",
    "business": {
      "id": "cb50eb42-22b3-4df4-bbcd-efcd9694f3f8",
      "name": "XYZ Car Servicing"
    }
  }
}

Get lead

Retrieve lead

Retrieve a single lead

GEThttps://api2.engineroom.com.au/public/leads/{id}

Authorization

bearerAuth

Path parameters

id*string

Lead ID

Example: "751dd3d0-23ae-4a4a-9049-6982423da87a"

Header parameters

Response

200401

Success

Body

application/json

idstring

Example: "751dd3d0-23ae-4a4a-9049-6982423da87a"

typestring

Example: "form"

google_client_idstring

Example: 123456789.98765433

lead_datestring

Example: "2023-01-01 10:30:00"

namestring

Example: "John Smith"

emailstring

Example: "[e-mail]"

phonestring

Example: "0411 111 111"

messagestring

Example: "I'm looking for a price for a car service"

web_sourcestring

Example: "google"

web_campaignstring

Example: "Location Based"

web_mediumstring

Example: "paid"

web_keywordstring

Example: "Sydney Car Service"

quality_scorestring

Example: 6.5

engagement_scorestring

Example: 8

form_namestring

Example: "Contact Us"

urlstring

Example: "https://www.sydcarservice.xyz/contact-us"

dataobject

linkstring

Example: "https://app.engineroom.com.au/leads/751dd3d0-23ae-4a4a-9049-6982423da87a&business=46580dbc-da00-4316-9a2d-c04a133741aa"

businessobject

Request

JavaScriptCurlPython

const response = await fetch('https://api2.engineroom.com.au/public/leads/{id}', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>",
      "Accept": "application/json"
    },
});
const data = await response.json();

Response

200401

{
  "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": "[e-mail]",
  "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"
  }
}