Business - Leads

Fetch all leads

Endpoint

GET /api/v1/leads

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

Headers

Accept: application/json
Content-Type: application/json
App-Id: 93670231-16fb-4051-bd9b-a109291e87bc
App-Secret: N6WxANzp1R0l6Vo6udsWBrVJnP82c9UYr3KrzyVq
Franchise-Id: 250

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 4335ecaf-fc91-4d5d-b2a8-a88f37d9fc90
Content-Length: 1705

Body

{
  "meta": {
    "status": "ok",
    "total_count": 1,
    "per_page": 25
  },
  "data": [
    {
      "id": "27",
      "type": "lead",
      "attributes": {
        "id": 27,
        "email": "john.smith17@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": 310,
        "brand_name": "Volkman, Rohan and McCullough 119",
        "created_at": "2023-10-27T17:37:03.710-07:00",
        "token": "YC7-CF7T-H2M",
        "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
      }
    }
  ]
}