Business - Leads

Fetch lead by ID

Endpoint

GET /api/v1/leads/:lead_id

Parameters

Name Description
email Email Address
text Search all text
origin Origin (One of Lead Form,Event Booking Form,Contact Form,Zapier,App,API)
lead_type Type (Set up under Manage -> Business Settings -> Leads)
source Source (Set up under Manage -> Business Settings -> Leads)

Request

Route

GET /api/v1/leads/30

Headers

Accept: application/json
Content-Type: application/json
App-Id: 698d3caf-f9a7-4c55-8f15-8b44367c03d2
App-Secret: tNDGrwDcLQZi4mGgBr92CYNFFCjgICPRerTqJHXJ
Franchise-Id: 255

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: d7789026-58a0-4aae-8899-ff6b05df1755
Content-Length: 1672

Body

{
  "meta": {
    "status": "ok"
  },
  "data": {
    "id": "30",
    "type": "lead",
    "attributes": {
      "id": 30,
      "email": "john.smith20@example.com",
      "first_name": "John",
      "last_name": "Smith",
      "company_name": null,
      "phone": "951-555-1212",
      "event_date": "11-10-2023",
      "event_time": "4:00pm",
      "venue_name": null,
      "venue_address": null,
      "venue_city": null,
      "venue_state": null,
      "venue_zip": null,
      "venue_map_url": "https://www.google.com/maps/search/",
      "venue_latitude": null,
      "venue_longitude": null,
      "venue_google_place_id": null,
      "estimated_budget": null,
      "estimated_number_guests": null,
      "subject": null,
      "message": null,
      "source": null,
      "notes": null,
      "lead_event_type": null,
      "lead_type": null,
      "last_contact_at": null,
      "times_contacted": 0,
      "origin": "Event Booking Form",
      "length_in_hours": 8.0,
      "length_in_minutes": 480,
      "indoor_outdoor": "",
      "starts_at": "2023-11-10T16:00:00.000-08:00",
      "ends_at": "2023-11-11T00:00:00.000-08:00",
      "title": "John Smith",
      "setup_at": null,
      "pickup_at": null,
      "dropoff_at": null,
      "brand_id": 318,
      "brand_name": "Hane, Kilback and Swaniawski 127",
      "created_at": "2023-10-27T17:37:06.913-07:00",
      "token": "MGM-CK7A-DMX",
      "spam": false,
      "archived": false,
      "converted_to_event": false,
      "length_in_days": null,
      "event_type_id": null,
      "utm_source": null,
      "utm_campaign": null,
      "utm_medium": null,
      "utm_term": null,
      "utm_content": null,
      "gclid": null,
      "package_name": null,
      "package_group_name": null,
      "service_name": null,
      "length": 8.0,
      "formatted_time_range": "4:00 PM - 12:00 AM",
      "formatted_date_range": "November 10 - November 11, 2023",
      "formatted_datetime_range": "Friday, November 10, 2023 • 4:00 PM - 12:00 AM",
      "custom_fields": [

      ],
      "created_at_description": "Created less than a minute ago",
      "referred_by_user_id": null,
      "referred_by_user_name": null,
      "referred_by_user_email": null
    }
  }
}