Master List
Master List (for reference)
GET /v1/leads/master-list
Note
This provide the Master list we are using in the create lead. Based on List Id, you can get the specific list.
Response
[
{
"listName": "Company",
"List Id": 0,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Branch",
"List Id": 1,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Brand",
"List Id": 2,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Department",
"List Id": 3,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Division",
"List Id": 4,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Priority",
"List Id": 75,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "CustomerType",
"List Id": 27,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Company Industry Type",
"List Id": 39,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Title",
"List Id": 50,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Nationality",
"List Id": 51,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Gender",
"List Id": 52,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Occupation",
"List Id": 53,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Language",
"List Id": 54,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Contact Type",
"List Id": 55,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Country",
"List Id": 56,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Purchase Plan",
"List Id": 59,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Payment Mode",
"List Id": 60,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Currency",
"List Id": 61,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Phone Code",
"List Id": 62,
"parentList Id": 56,
"parentListName": "Country"
},
{
"listName": "ModelFamily",
"List Id": 63,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Model Year",
"List Id": 64,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Lead Source",
"List Id": 70,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Lead Sub Source",
"List Id": 71,
"parentList Id": 70,
"parentListName": "Lead Source"
},
{
"listName": "Lead Interest",
"List Id": 74,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Lead Monthly Income",
"List Id": 78,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Lead Vehicle Type",
"List Id": 79,
"parentList Id": 0,
"parentListName": ""
},
{
"listName": "Customer Region",
"List Id": 100,
"parentList Id": 56,
"parentListName": "Country"
},
{
"listName": "Customer City",
"List Id": 101,
"parentList Id": 100,
"parentListName": "Customer Region"
}
]
Master list based on lookup types (without language specific)
GET /v1/leads/list
Query Parameters
List Id will get the drop down list based on lookuptypeNote
Refer the List Id from master lookup list parentList Id and parentId: applicable for Region and City
Example for Region:
listId: Region LookupId from master list (List Id 100)
parentListId: Country master Id (List Id 56)
parentId: Country Id which is selected (List Id 56, Saudi Arabia)
Example for City:
listId: City LookupId from master list (List Id 101)
parentListId: Region master Id (List Id 100)
parentId: Region Id which is selected (List Id 100, Riyadh)
Master list based on lookup types (with language specific)
GET /v2/leads/list
Query Parameters
listId: integer (default: 0)
parentListId: integer (default: 0)
parentId: integer (default: 0)
lang: string (default "en") "en" | "ar"
This will provide the master list based on the language provided, default is en
Response
[
{
"listName": "Company",
"id": 1,
"text": "JTC", // Text based on lang passed
"code": "JTC",
"listId": 0,
"parentListId": 0,
"parentId": 0,
"regularExpression": ""
},
{
"listName": "Branch",
"id": 1,
"text": "الرياض - القادسية", // Text based on lang passed
"code": "LYK1",
"listId": 1,
"parentListId": 0,
"parentId": 0,
"regularExpression": ""
}
]
Branch list (with language specific)
GET /v2/leads/branchlist
Query Parameters
brandId: integer (default: 0)
departmentId: integer (default: 0)
regionId: integer (default: 0)
cityId: integer (default: 0)
branchId: integer (default: 0)
lang: string (default "en") "en" | "ar"
This will provide the branch list based on the language provided, default is en
Response
[
{
"branchId": 2,
"branchCode": "LYK2",
"branchText": "Dammam - Rakah Showroom",
"countryId": 1,
"countryText": "Saudi Arabia",
"description": "Dammam - Rakah Showroom",
"regionId": 1,
"regionText": "Eastern",
"cityId": 1,
"cityText": "Dammam",
"addressText": "Al Rakah Ash Shamaliyah, Dammam",
"brandId": 3,
"brandText": "Lynk&Co",
"brandCode": "LYNKCO",
"departmentId": 2,
"departmentText": "Sales",
"location": "https://maps.app.goo.gl/z2Cnp6N5PD5zAjiD7",
"notesText": null
},
{
"branchId": 4,
"branchCode": "JMC1",
"branchText": "Dammam - Rakah Showroom",
"countryId": 1,
"countryText": "Saudi Arabia",
"description": "Dammam - Rakah Showroom",
"regionId": 1,
"regionText": "Eastern",
"cityId": 1,
"cityText": "Dammam",
"addressText": "Al Rakah Ash Shamaliyah, Dammam",
"brandId": 2,
"brandText": "JMC",
"brandCode": "JMC",
"departmentId": 2,
"departmentText": "Sales",
"location": "https://maps.app.goo.gl/kqM6z5VAfL4kNKCa7",
"notesText": null
},
]