{ "openapi": "3.1.0", "info": { "title": "LeadLocate API", "version": "1.0.0", "description": "Live dealership inventory from LeadLocate CRM for the salesperson who owns the API key, plus create only endpoints that save new work into the CRM. Search the lot, open any vehicle, get a Facebook Marketplace listing kit, and save files, Design Studio designs, message templates, My Office notes and To Dos. Nothing can be deleted or changed, customer records are not reachable, and nothing is sent to anyone.", "contact": { "name": "LeadLocate Support", "url": "https://leadlocate.com/sales-leads/contact-us" }, "termsOfService": "https://leadlocate.com/sales-leads/terms-of-service" }, "servers": [ { "url": "https://leadlocate.com/api/v1" } ], "security": [ { "bearerAuth": [] } ], "paths": { "/me": { "get": { "operationId": "getMe", "summary": "Who this key belongs to", "description": "The salesperson and dealership the API key belongs to. Call this first to confirm the connection.", "responses": { "200": { "description": "The user and dealership", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Me" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/inventory": { "get": { "operationId": "searchInventory", "summary": "Search the dealership inventory", "description": "Every vehicle currently on the lot, live from the dealership feed. All filters are optional and combine. Use q for free text such as \"2021 tahoe\" or \"white suv\".", "parameters": [ { "name": "q", "in": "query", "required": false, "description": "Free text matched against year, make, model, trim, VIN, stock number, color, body style and drivetrain. Every word must match.", "schema": { "type": "string" } }, { "name": "condition", "in": "query", "required": false, "description": "new or used", "schema": { "type": "string", "enum": [ "new", "used" ] } }, { "name": "make", "in": "query", "required": false, "description": "Exact make, for example Chevrolet", "schema": { "type": "string" } }, { "name": "model", "in": "query", "required": false, "description": "Model contains this text, for example Tahoe", "schema": { "type": "string" } }, { "name": "body_style", "in": "query", "required": false, "description": "For example SUV, Truck, Sedan, Minivan", "schema": { "type": "string" } }, { "name": "year_min", "in": "query", "required": false, "description": "Oldest model year", "schema": { "type": "integer" } }, { "name": "year_max", "in": "query", "required": false, "description": "Newest model year", "schema": { "type": "integer" } }, { "name": "price_min", "in": "query", "required": false, "description": "Lowest price in US dollars", "schema": { "type": "integer" } }, { "name": "price_max", "in": "query", "required": false, "description": "Highest price in US dollars", "schema": { "type": "integer" } }, { "name": "mileage_max", "in": "query", "required": false, "description": "Highest odometer reading", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "required": false, "description": "Result order. Default is new vehicles first, then lowest price.", "schema": { "type": "string", "enum": [ "price_asc", "price_desc", "year_desc", "mileage_asc" ] } }, { "name": "limit", "in": "query", "required": false, "description": "Results per page, 1 to 100. Default 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "required": false, "description": "Results to skip, for paging.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "Matching vehicles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryPage" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/inventory/{id}": { "get": { "operationId": "getVehicle", "summary": "One vehicle with full details", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Vehicle id from a search result, or the VIN, or the stock number.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The vehicle", "content": { "application/json": { "schema": { "type": "object", "properties": { "vehicle": { "$ref": "#/components/schemas/Vehicle" }, "meta": { "$ref": "#/components/schemas/InventoryMeta" } } } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/inventory/{id}/marketplace": { "get": { "operationId": "getMarketplaceListing", "summary": "Facebook Marketplace listing kit for a vehicle", "description": "Everything needed to list this vehicle on Facebook Marketplace from the salesperson's own account: the vehicle form's fields using Facebook's own option labels, a ready description, photos, and the post_url to open. Fields listed in needs_seller_input must be confirmed by the salesperson before publishing.", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Vehicle id from a search result, or the VIN, or the stock number.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "The listing kit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketplaceKit" } } } }, "404": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/files": { "post": { "operationId": "createFile", "summary": "Save a file to the File Library", "description": "Fetches a public https link and saves it as a new File Library file for the key owner: JPG, PNG, GIF or WebP up to 25 MB, MP4, MOV or WebM up to 250 MB, PDF up to 50 MB. Returns the share link. Creates only; never replaces anything.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "file_url": { "type": "string", "description": "Public https link to the file." }, "name": { "type": "string", "description": "Display name.", "maxLength": 120 }, "folder": { "type": "string", "description": "Folder name. Created if it does not exist yet.", "maxLength": 60 } }, "required": [ "file_url" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object", "properties": { "saved_to": { "type": "string", "description": "" }, "name": { "type": "string", "description": "" }, "type": { "type": "string", "description": "image, video or pdf" }, "folder": { "type": "string", "description": "" }, "share_link": { "type": "string", "description": "" }, "file_url": { "type": "string", "description": "" } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "429": { "$ref": "#/components/responses/ErrorResponse" } } } }, "/designs": { "post": { "operationId": "createDesign", "summary": "Save a design to Design Studio", "description": "Fetches a finished image (JPG, PNG, GIF or WebP, up to 25 MB) and saves it as a new Design Studio design in the chosen format.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "file_url": { "type": "string", "description": "Public https link to the image." }, "name": { "type": "string", "description": "Design name.", "maxLength": 100 }, "format": { "type": "string", "description": "Canvas format.", "enum": [ "original", "feed45", "square", "story", "landscape" ] } }, "required": [ "file_url" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object", "properties": { "saved_to": { "type": "string", "description": "" }, "design_name": { "type": "string", "description": "" }, "format": { "type": "string", "description": "" } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "429": { "$ref": "#/components/responses/ErrorResponse" } } } }, "/templates": { "post": { "operationId": "createTemplate", "summary": "Save a message template", "description": "Saves a new text message or email template for the dealership. Saved only; nothing is sent.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Template type.", "enum": [ "sms", "email" ] }, "title": { "type": "string", "description": "Template name.", "maxLength": 80 }, "body": { "type": "string", "description": "Plain text. Text messages up to 1600 characters.", "maxLength": 10000 }, "subject": { "type": "string", "description": "Email subject.", "maxLength": 200 } }, "required": [ "type", "title", "body" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object", "properties": { "saved_to": { "type": "string", "description": "" }, "title": { "type": "string", "description": "" } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "429": { "$ref": "#/components/responses/ErrorResponse" } } } }, "/notes": { "post": { "operationId": "createNote", "summary": "Add a My Office note", "description": "Adds a new sticky note to the key owner's private My Office desk.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "text": { "type": "string", "description": "Note text.", "maxLength": 4000 }, "color": { "type": "string", "description": "Note color.", "enum": [ "yellow", "green", "blue", "pink" ] } }, "required": [ "text" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object", "properties": { "saved_to": { "type": "string", "description": "" }, "color": { "type": "string", "description": "" } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "429": { "$ref": "#/components/responses/ErrorResponse" } } } }, "/todos": { "post": { "operationId": "createTodo", "summary": "Add a To Do", "description": "Adds a new To Do for the key owner. Never linked to a customer and never texts a reminder.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "To Do title.", "maxLength": 255 }, "notes": { "type": "string", "description": "Notes.", "maxLength": 8000 }, "due": { "type": "string", "description": "Due date in dealership time, YYYY-MM-DD or YYYY-MM-DD HH:MM." }, "priority": { "type": "integer", "enum": [ 1, 2, 3 ], "description": "1 high, 2 normal, 3 low." } }, "required": [ "title" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Saved", "content": { "application/json": { "schema": { "type": "object", "properties": { "saved_to": { "type": "string", "description": "" }, "title": { "type": "string", "description": "" }, "due": { "type": "string", "description": "" } } } } } }, "400": { "$ref": "#/components/responses/ErrorResponse" }, "401": { "$ref": "#/components/responses/ErrorResponse" }, "403": { "$ref": "#/components/responses/ErrorResponse" }, "429": { "$ref": "#/components/responses/ErrorResponse" } } } }, "/folders": { "get": { "operationId": "listFolders", "summary": "List File Library folders", "description": "Folder names in the dealership's File Library. Names only; files are never listed.", "responses": { "200": { "description": "Folders", "content": { "application/json": { "schema": { "type": "object", "properties": { "folders": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "" }, "yours": { "type": "boolean" } } } } } } } } }, "401": { "$ref": "#/components/responses/ErrorResponse" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A personal LeadLocate API key (starts with llk_). Create one at https://leadlocate.com/pd-admin/connect" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } }, "Dealership": { "type": "object", "properties": { "name": { "type": "string" }, "city": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ] }, "zip": { "type": [ "string", "null" ] }, "inventory_connected": { "type": "boolean" } } }, "Me": { "type": "object", "properties": { "user": { "type": "object", "properties": { "name": { "type": "string" }, "email": { "type": "string" } } }, "dealership": { "$ref": "#/components/schemas/Dealership" } } }, "InventoryMeta": { "type": "object", "properties": { "fetched_at": { "type": [ "string", "null" ], "format": "date-time" }, "stale": { "type": "boolean", "description": "The live feed did not answer, so this is the last complete copy." }, "partial": { "type": "boolean" }, "collecting": { "type": "boolean", "description": "The first inventory collection for this store is still running." } } }, "VehicleSummary": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "condition": { "type": "string", "enum": [ "new", "used" ] }, "year": { "type": [ "integer", "null" ] }, "make": { "type": "string" }, "model": { "type": "string" }, "trim": { "type": "string" }, "price": { "type": [ "integer", "null" ] }, "mileage": { "type": [ "integer", "null" ] }, "exterior_color": { "type": "string" }, "body_style": { "type": "string" }, "vin": { "type": "string" }, "stock_number": { "type": "string" }, "photo": { "type": [ "string", "null" ] }, "links": { "type": "object", "properties": { "self": { "type": "string" }, "marketplace": { "type": "string" } } } } }, "Vehicle": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "condition": { "type": "string" }, "year": { "type": [ "integer", "null" ] }, "make": { "type": "string" }, "model": { "type": "string" }, "trim": { "type": "string" }, "price": { "type": [ "integer", "null" ] }, "msrp": { "type": [ "integer", "null" ] }, "mileage": { "type": [ "integer", "null" ] }, "vin": { "type": "string" }, "stock_number": { "type": "string" }, "exterior_color": { "type": "string" }, "interior_color": { "type": "string" }, "body_style": { "type": "string" }, "transmission": { "type": "string" }, "engine": { "type": "string" }, "fuel_type": { "type": "string" }, "drivetrain": { "type": "string" }, "photos": { "type": "array", "items": { "type": "string" } }, "listing_url": { "type": "string" }, "links": { "type": "object" } } }, "InventoryPage": { "type": "object", "properties": { "dealership": { "$ref": "#/components/schemas/Dealership" }, "meta": { "allOf": [ { "$ref": "#/components/schemas/InventoryMeta" }, { "type": "object", "properties": { "total": { "type": "integer" }, "returned": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" } } } ] }, "vehicles": { "type": "array", "items": { "$ref": "#/components/schemas/VehicleSummary" } } } }, "MarketplaceKit": { "type": "object", "properties": { "vehicle_id": { "type": "string" }, "title": { "type": "string" }, "marketplace": { "type": "object", "properties": { "post_url": { "type": "string", "description": "Facebook Marketplace vehicle listing form" }, "fields": { "type": "object", "properties": { "vehicle_type": { "type": "string" }, "photos": { "type": "array", "items": { "type": "string" } }, "location_zip": { "type": [ "string", "null" ] }, "location_city": { "type": [ "string", "null" ] }, "year": { "type": [ "integer", "null" ] }, "make": { "type": "string" }, "model": { "type": "string" }, "mileage": { "type": [ "integer", "null" ] }, "price": { "type": [ "integer", "null" ] }, "body_style": { "type": [ "string", "null" ], "enum": [ "Coupe", "Truck", "Sedan", "Hatchback", "SUV", "Convertible", "Wagon", "Minivan", "Other", null ] }, "exterior_color": { "type": [ "string", "null" ] }, "interior_color": { "type": [ "string", "null" ] }, "vehicle_condition": { "type": [ "string", "null" ], "enum": [ "Excellent", "Very good", "Good", "Fair", "Poor", null ] }, "fuel_type": { "type": [ "string", "null" ] }, "transmission": { "type": [ "string", "null" ], "enum": [ "Automatic transmission", "Manual transmission", null ] }, "clean_title": { "type": [ "boolean", "null" ] }, "description": { "type": "string" } } }, "needs_seller_input": { "type": "array", "items": { "type": "string" }, "description": "Fields the salesperson must fill or confirm before publishing." }, "guidance": { "type": "array", "items": { "type": "string" } }, "listing_url": { "type": "string", "description": "The vehicle's page on the dealership website, with the full photo set." } } }, "meta": { "$ref": "#/components/schemas/InventoryMeta" }, "links": { "type": "object" } } } }, "responses": { "ErrorResponse": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }