Quick Start

Learn how to get started with the EngineRoom REST API

Get your API key

Your API requests are authenticated using an API key. Any request that doesn't include an API key will return an error.

You can request an API key by emailing [e-mail]

Make your first request

To make your first request, send an authenticated request to the leads endpoint. This will create a lead in the EngineRoom platform.

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"
    }
  }
}