# Quick Start

## 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 <dev@engineroom.com.au>

## 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

```json
{"openapi":"3.0.0","info":{"title":"EngineRoom Public API","version":"1.0.0"},"servers":[{"url":"https://api2.engineroom.com.au/public"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"paths":{"/leads":{"post":{"summary":"Create a new lead","description":"Create a new lead entry","tags":["Leads"],"parameters":[{"name":"Accept","in":"header","description":"Setting to `application/json` is recommended","required":true,"schema":{"type":"string"}},{"name":"lead_date","in":"query","description":"Lead creation datetime (UTC). Defaults to now if blank.","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","description":"User Name","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","description":"Lead Email Address","required":false,"schema":{"type":"string"}},{"name":"phone","in":"query","description":"Lead Phone Number","required":false,"schema":{"type":"string"}},{"name":"message","in":"query","description":"Message / Content from Form","required":false,"schema":{"type":"string"}},{"name":"google_client_id","in":"query","description":"Google Client ID","required":false,"schema":{"type":"string"}},{"name":"web_source","in":"query","description":"Source of Lead E.g \"google\" or \"direct\"","required":false,"schema":{"type":"string"}},{"name":"web_campaign","in":"query","description":"Campaign Attribution","required":false,"schema":{"type":"string"}},{"name":"web_medium","in":"query","description":"Medium Attribution E.g \"paid\" or \"organic\"","required":false,"schema":{"type":"string"}},{"name":"web_keyword","in":"query","description":"Keyword Attribution","required":false,"schema":{"type":"string"}},{"name":"form_name","in":"query","description":"Name of form lead completed","required":false,"schema":{"type":"string"}},{"name":"url","in":"query","description":"URL of Lead Acquisition","required":false,"schema":{"type":"string"}},{"name":"data","in":"query","description":"Additional Information (JSON String)","required":false,"schema":{"type":"string"}}],"responses":{"201":{"description":"Lead created successfully","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"data":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"google_client_id":{"type":"string"},"lead_date":{"type":"string"},"name":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"message":{"type":"string"},"web_source":{"type":"string"},"web_campaign":{"type":"string"},"web_medium":{"type":"string"},"web_keyword":{"type":"string"},"url":{"type":"string"},"data":{"type":"object"},"link":{"type":"string"},"business":{"type":"object"}}}}}}}},"400":{"description":"Invalid input"}}}}}}
```
