Get Enquiry List
Lists the leads (enquiries) of an organization, newest first, one page at a time, with follow-up details and custom fields. Use it to copy leads into a CRM or report on them.
/organization/enquiriescurl --request GET \
--url 'https://<your-api-host>/nuSource/api/v1/organization/enquiries?lead_status=1,9,3,5,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25&followup_status=0&organization_id=<organizationId>' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>'{
"code": 200,
"message": "Success",
"enquiries": [
{
"enquiry_id": 59085,
"name": "MEGALADEVI.K",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "8056736484",
"email": "kmegaladevi14@gmail.com",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 70,
"appointment_date": 0,
"enquiry_time": 1667413800,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1667413800,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220016,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "INTERESTED",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "",
"parent_contact": "",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "2",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 59085
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 59068,
"name": "samvedha",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "8888888888",
"email": "testst@gmail.com",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 255,
"target_exam": "",
"source": 66,
"appointment_date": 0,
"enquiry_time": 1667327400,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1667384337,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220015,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "test",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "",
"parent_contact": "",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 6267,
"field_name": "name1",
"field_display_name": "Name123",
"field_value": "",
"is_active": 0,
"show_offline": 0,
"field_type": 2,
"enquiry_id": 59068
},
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 59068
},
{
"field_id": 6247,
"field_name": "custom_field_",
"field_display_name": "Custom Field ",
"field_value": "",
"is_active": 1,
"show_offline": 1,
"field_type": 1,
"enquiry_id": 59068
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 59066,
"name": "saaa",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "9898989898",
"email": "",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 66,
"appointment_date": 0,
"enquiry_time": 1667327400,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1667327400,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220014,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "",
"parent_contact": "",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 59066
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 55159,
"name": "RISHAB ENQUIRY TEST 1",
"lead_status": 3,
"enquiry_type": 0,
"contact_number": "7355031540",
"email": "",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 1,
"appointment_date": 0,
"enquiry_time": 1654108200,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1659953286,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220013,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "",
"alt_contact_number": null,
"followup_date": 1660302600,
"qualification": 0,
"followup_count": 1,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "",
"parent_contact": "",
"parent_email": "",
"next_followup_id": 30445,
"next_followup_date": 1660302900,
"next_followup_comment": "",
"followup_id": 30444,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 6267,
"field_name": "name1",
"field_display_name": "Name123",
"field_value": "",
"is_active": 0,
"show_offline": 0,
"field_type": 2,
"enquiry_id": 55159
},
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 55159
},
{
"field_id": 6247,
"field_name": "custom_field_",
"field_display_name": "Custom Field ",
"field_value": "",
"is_active": 1,
"show_offline": 1,
"field_type": 1,
"enquiry_id": 55159
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 55158,
"name": "RISHAB ENQUIRY TEST",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "7355031540",
"email": "rishab@edmingle.com",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 1,
"appointment_date": 0,
"enquiry_time": 1654108200,
"enquiry_created": null,
"owner_id": 200,
"gender": 1,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1654108200,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220012,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "Rishab Father",
"parent_contact": "8798789878",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 55158
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 55157,
"name": "HEMAL ENQUIRYTEST",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "9265075346",
"email": "hemal@edmingle.com",
"organization_id": 212,
"standard": 252,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 66,
"appointment_date": 0,
"enquiry_time": 1654108200,
"enquiry_created": null,
"owner_id": 200,
"gender": 1,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1654108200,
"course_package": 1515,
"preferred_slot": 68,
"occupation": 0,
"religion": 0,
"enquiry_code": 220011,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 68,
"tentative_batch": null,
"course_ids": "2557,2558,2559,2795,2590,2632",
"parent_name": "JohnWick",
"parent_contact": "9724747559",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 55157
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 55155,
"name": "CHANDAN",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "8638547894",
"email": "",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 1,
"appointment_date": 0,
"enquiry_time": 1654108200,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1654108200,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220010,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "",
"parent_contact": "",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 55155
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 55152,
"name": "CHANDAN",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "8638547903",
"email": "",
"organization_id": 212,
"standard": 0,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 1,
"appointment_date": 0,
"enquiry_time": 1654108200,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
"address": "",
"city": "",
"follow_up_type": 1,
"updated_at": 1654108200,
"course_package": -1,
"preferred_slot": 0,
"occupation": 0,
"religion": 0,
"enquiry_code": 220009,
"followup_comment": "",
"user_id": 0,
"enquiry_notes": "",
"alt_contact_number": null,
"followup_date": 0,
"qualification": 0,
"followup_count": 0,
"slot": 0,
"tentative_batch": null,
"course_ids": "",
"parent_name": "",
"parent_contact": "",
"parent_email": "",
"next_followup_id": 0,
"next_followup_date": 0,
"next_followup_comment": "",
"followup_id": null,
"dob": -1,
"school": 0,
"area": 0,
"custom_fields": [
{
"field_id": 6267,
"field_name": "name1",
"field_display_name": "Name123",
"field_value": "12",
"is_active": 0,
"show_offline": 0,
"field_type": 2,
"enquiry_id": 55152
},
{
"field_id": 169348,
"field_name": "gender..",
"field_display_name": "Gender..",
"field_value": "1",
"is_active": 1,
"show_offline": 1,
"field_type": 3,
"enquiry_id": 55152
}
],
"contact_number_country_id": 103,
"alt_contact_number_country_id": 0,
"parent_contact_country_id": 103,
"contact_number_dial_code": "+91",
"alt_contact_number_dial_code": "",
"parent_contact_dial_code": "+91"
},
{
"enquiry_id": 55147,
"name": "RISHABH",
"lead_status": 1,
"enquiry_type": 0,
"contact_number": "7355031540",
"email": "rishabh@edmingle.com",
"organization_id": 212,
"standard": 253,
"board": 0,
"stream": 1,
"target_exam": "",
"source": 1,
"appointment_date": 0,
"enquiry_time": 1654108200,
"enquiry_created": null,
"owner_id": 200,
"gender": 0,
Access: Institute admins, plus custom roles that can manage leads and enquiries. Counsellors who own leads only see their own.
0 not converted to a learner, 1 converted, 2 all (default).enquiry_end_date: leads created in this range.1 with a pending follow-up, 2 with a completed follow-up.followup_end: leads with a follow-up dated in this range.Response: enquiries is an array. Each lead has enquiry_id, enquiry_code, name, email, contact_number, alt_contact_number, dial-code and country fields, gender, dob, address, city, area, school, qualification, occupation, religion, organization_id, lead_status, enquiry_type, source, standard, board, stream, target_exam, course_package, course_ids, preferred_slot, tentative_batch, owner_id, user_id (learner account, if converted), parent_name, parent_contact, parent_email, enquiry_notes, enquiry_time and updated_at (Unix timestamps), appointment_date, follow_up_type, followup_count, the last completed follow-up (followup_id, followup_date, followup_comment), the next pending one (next_followup_id, next_followup_date, next_followup_comment) and custom_fields (each with field_id, field_name, field_display_name, field_value, field_type; file fields come back as links). page_context gives page, per_page, total_rows and has_more_page.
Notes: Cancelled leads are left out. Values such as lead_status and source are IDs from your institute's lead settings. Contact details may be personal data; store them securely. Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.