Introduction
Welcome to the Toolyt API document! You can use our API to access Toolyt API endpoints, which can get information on users, leads, customers, expences, visits, and products in our database.
We build all our code as json response. You can view code examples in the dark area to the right, and you can switch the header, body, response and smaple data with the tabs in the top right.
Sample data include format of input if the method is post. Body and header shows the input format. Response is output sample.
Get Token : GET
URL : https://api.toolyt.com/get-token
{
"status": 200,
"error": false,
"token": "txKjR0HkEmXymNPPYNMYzD72ZP5KowcRCGA3c93r"
}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module. apiKey : o9orfl4km83luxzd7vltToolyt uses API keys to allow access to the API. You will get API key from our website, if you are registered with Toolyt and API module is activated.
For all other API calls Toolyt expects API key to be included in header of all API requests to the server, that looks like the following:
AuthorizationKey: apiKey
Return error false and a token, if the request is success. Otherwise it will return a error tru with message.
Get Company Details : GET
URL : https://api.toolyt.com/get-company-details
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"company": {
"id": 11,
"company_name": "Toolyt",
"full_name": "Toolyt",
"phone": "0000000000",
"email": "example@example.com",
"user_limit": 10,
"company_address": "",
"order_id_prefix": "ORD_TOOLYT",
"order_id_number": 100,
"job_reference_prefix": "JB_TOOLYT",
"job_reference_number": 0
}
}
apiKey : o9orfl4km83luxzd7vltThis endpoint retrieves company details. You can use "company_id" in response of this API call for other API calls, which passsing company id as input parameter.
Get Users : GET
URL : https://api.toolyt.com/get-users/{PageNumber}/{noOfRecords}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"total_users": 4,
"baseUrl": "https://toolyt.com/app/public/images/profile_pic/",
"users": [
{
"user_id": 15,
"first_name": "Vidhya",
"last_name": "M",
"phone": "0000000000",
"email": "user1.toolyt.com",
"profile_pic": "",
"address": "Nasscom Warehouse Diamond District,Bangalore, India",
"designation": "Manager"
},
{
"user_id": 16,
"first_name": "Amjad",
"last_name": "Ali",
"phone": "0000000000",
"email": "user2@example.com",
"profile_pic": "20160323120554.jpg",
"address": "Nasscom Warehouse Diamond District,Bangalore, India",
"designation": "Executive"
}
]
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
noOfRecords : No of users per page.
The endpoint retrieves details of all users in Toolyt. The 'PageNumber' indicates the number of pages and the 'noOfRecords' refers to count of users to be returned per page.
Get User Details : GET
URL : https://api.toolyt.com/get-user-details/{userID}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"baseUrl": "https://toolyt.com/app/public/images/profile_pic/",
"user": {
"user_id": 50,
"first_name": "My user b",
"last_name": "M",
"phone": "0000000002",
"email": "",
"profile_pic": "",
"address": "",
"designation": "Sales Executive",
"middle_name": "",
"employee_number": "EMP071",
"department": "Sales"
}
}
apiKey : o9orfl4km83luxzd7vlt
The end point retrieves the details of a specific user.
Create Customer Form : GET
URL : https://api.toolyt.com/get-customer-form
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
apiKey : o9orfl4km83luxzd7vlt
Create Lead : POST
URL : https://api.toolyt.com/create-lead
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Lead added successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-lead HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"user_id":18,
"full_name": "Full Name",
"company_name":"Company Name",
"address":4,
"location_latitude":"45.3232",
"location_longitude":"23.543",
"mobile":1234567890,
"photos":[{"0":"Base 64 Encoded Image 1","1":"Base 64 Encoded Image 2"}]
"next_action_date":"2016-01-01",
"next_action_time":"10:00:00",
"no__of_fieldforce1":"2",
"test_check3":"ddd",
"test_check3":"val 1,val 2",
"test_radio4":"b,d,c",
"test_select_box5": box 1,
"assign_to": 179,
"industry": 15,
"lead_source": 343,
"lead_owner": 1815,
"status_type": 0,
"lead_progress" : 187,
"country": 2,
"image":"Base 64 Encoded Image",
"lct1": "asa",
"designation": Developer,
"alternate_phone": 1234567890,
"mark_as_visited_val": 1,
"visit_mode_id": 12
}
This endpoint is to create lead. Pass the user_id who has permissions to add lead. Data will pass as form data.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the assigned_to_id products as an array.
Get Leads : GET
URL : https://api.toolyt.com/get-leads/{pageNumber}/{noOfRecords}?from_date=yyyy-mm-dd hh:mm:ss&to_date=yyyy-mm-dd hh:mm:ss
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"baseUrl": "https://toolyt.com/app/public/images/customer_pic/",
"total_leads": 18,
"leads": [
{
"lead_id": 103,
"full_name": "Sajith I K",
"company_name": "MN Enterprises",
"designation": "HR",
"phone": null,
"alternate_phone": null,
"land_line": null,
"email": null,
"address": null,
"website": null,
"profile_pic": "345443544435.jpg",
},
{
"lead_id": 127,
"full_name": "Amjad Ali",
"company_name": "MCR",
"designation": "CEO",
"phone": "",
"alternate_phone": "23456787654",
"land_line": "",
"email": "example@example.com",
"address": " Nasscom Warehouse Diamond District, Bangalore",
"website": "",
"profile_pic": "345443544495.jpg",
}
]
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
noOfRecords : No of leads per page.
from_date : Start Date
to_date :End Date
The endpoint retrieves the details of all active leads in Toolyt for a specific date range. The 'pageNumber' indicates the number of pages and the 'noOfRecords' refers to count of leads to be returned per page.
'from_date' and 'to_date' need to be in yyyy-mm-dd hh:mm:ss(IST) format
Get Lead Details : GET
URL : https://api.toolyt.com/get-lead-details/{leadID}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"profilePicUrl": "https://toolyt.com/app/public/images/customer_pic/",
"photoUrl": "https://toolyt.com/app/public/images/customer_photos/",
"documentUrl": "https://toolyt.com/app/public/images/customer_documents/",
"lead": {
"lead_id": 122,
"full_name": "Rahman",
"company_name": "Rahman Clinics",
"designation": "CEO",
"phone": "",
"alternate_phone": "2345678909876",
"land_line": "",
"email": "example@example.com",
"address": "MES Pattambi",
"website": "",
"profile_pic": "20161012052942.png",
"location": "",
"country_name": "India",
"state_name": null,
"district_name": null,
"area_name": null,
"expected_value": 3900,
"assigned_date": "2016-10-12 17:29:40",
"lead_status": "First Contact to customer pending",
"lead_source": "Cold Call",
"photos": {
"0": "201610120529400.png",
},
"documents": {
},
"assigned_user_id": 4,
"assigned_user": "Prashob K",
"industry": "Hospitals",
"industry_category": null,
"industry_sub_category": null,
"ceo_name": "Rahman",
"contact_days": "Sunday, Monday",
"gender": "Male",
"lead_type": "Large Scale",
"no._of_beds": "4",
"description": "Lead with large value.",
"pin_code": "",
}
}
apiKey : o9orfl4km83luxzd7vlt
The end point retrieves the details of a specific lead.
Create Customer : POST
URL : https://api.toolyt.com/create-customer
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Customer added successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-customer HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"user_id":18,
"full_name": "Full Name",
"company_name":"Company Name",
"address":4,
"location_latitude":"45.3232",
"location_longitude":"23.543",
"mobile":1234567890,
"photos":[{"0":"Base 64 Encoded Image 1","1":"Base 64 Encoded Image 2"}]
"next_action_date":"2016-01-01",
"next_action_time":"10:00:00",
"no__of_fieldforce1":"2",
"test_check3":"ddd",
"test_check3":"val 1,val 2",
"test_radio4":"b,d,c",
"test_select_box5": box 1,
"assign_to": 179,
"industry": 15,
"lead_source": 343,
"lead_owner": 1815,
"status_type": 1,
"lead_progress" : 187,
"country": 2,
"image":"Base 64 Encoded Image",
"lct1": "asa",
"designation": Developer,
"alternate_phone": 1234567890,
"mark_as_visited_val": 1,
"visit_mode_id": 12
}
This endpoint is to create lead. Pass the user_id who has permissions to add customer. Data will pass as form data.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the assigned_to_id products as an array.
Get Customers : GET
URL : https://api.toolyt.com/get-customers/{pageNumber}/{noOfRecords}?from_date=yyyy-mm-dd hh:mm:ss&to_date=yyyy-mm-dd hh:mm:ss
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"baseUrl": "https://toolyt.com/app/public/images/customer_pic/",
"total_customers": 158,
"customers": [
{
"customer_id": 3036,
"full_name": "Rassack K",
"company_name": "DELL",
"designation": "",
"phone": "",
"alternate_phone": null,
"land_line": null,
"email": "",
"address": "",
"website": "",
"profile_pic": ""
},
{
"customer_id": 3037,
"full_name": "Amjad",
"company_name": "NDA",
"designation": "",
"phone": "9889898989",
"alternate_phone": "",
"land_line": "09588888885",
"email": "example@example.com",
"address": "Bangalore, Karnataka",
"website": "",
"profile_pic": ""
}
]
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
noOfRecords : No of customers per page.
from_date : Start Date
to_date :End Date
The endpoint retrieves the details of all active customers in Toolyt for a specific date range. The 'pageNumber' indicates the number of pages and the 'noOfRecords' refers to count of customers to be returned per page.
'from_date' and 'to_date' are to be in yyyy-mm-dd hh:mm:ss(IST) format
Get Customer Details : GET
URL : https://api.toolyt.com/get-customer-details/{customerID}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"profilePicUrl": "https://toolyt.com/app/public/images/customer_pic/",
"photoUrl": "https://toolyt.com/app/public/images/customer_photos/",
"documentUrl": "https://toolyt.com/app/public/images/customer_documents/",
"customer": {
"customer_id": 3037,
"full_name": "Amjad",
"company_name": "NDA",
"designation": "",
"phone": "9889898989",
"alternate_phone": "",
"land_line": "09588888885",
"email": "example@example.com",
"address": "Bangalore, Karnataka",
"website": "",
"profile_pic": "",
"location": "12.3633,72.3654",
"country_name": "India",
"state_name": "Karnataka",
"district_name": null,
"area_name": null,
"expected_value": 5000,
"created_date": "2016-12-09 17:36:12",
"lead_status": "Data added",
"lead_source": "Reseller",
"photos": {
"0": ""
},
"documents": {
"0": ""
},
"assigned_user_id": 179,
"assigned_user": "Amjad Ali U T ",
"industry": "Small/Medium Enterprises",
"industry_category": null,
"industry_sub_category": null,
"no._of_fieldforce": "",
"distributor": "",
"description": "",
"pin_code": "",
"age": "",
"type": "",
"education": "",
}
}
apiKey : o9orfl4km83luxzd7vlt
The end point retrieves the details of a specific customer.
Get Lost Leads : GET
URL : https://api.toolyt.com/get-lost-leads/{pageNumber}/{noOfRecords}?from_date=yyyy-mm-dd hh:mm:ss&to_date=yyyy-mm-dd hh:mm:ss
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"baseUrl": "https://toolyt.com/app/public/images/customer_pic/",
"total_leads": 23,
"leads": [
{
"lead_id": 9399,
"full_name": "Abcpqr",
"company_name": "Pqruvz",
"designation": "",
"phone": "",
"alternate_phone": "1289253685",
"land_line": "5242810185",
"email": "",
"address": "12°57'35.2\"N 77°38'37.1\"E, Diamond District Office Building, H A L Old Airport Rd, ISRO Colony, Kodihalli, Bengaluru, Karnataka 560017, India",
"website": "",
"profile_pic": "20170206954323.png"
},
{
"lead_id": 423,
"full_name": "Ajay Bhalaria",
"company_name": "Walplast Products Pvt. Ltd.",
"designation": "Marketing Head",
"phone": "7738398983",
"alternate_phone": "",
"land_line": "",
"email": "ajay.bhalaria@walplast.com",
"address": "",
"website": "",
"profile_pic": ""
}
]
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
noOfRecords : No of leads per page.
from_date :Start Date
to_date :End Date
the endpoint retrieves the details of all active customers in Toolyt for a specific date range. The 'pageNumber' indicates the number of pages and the 'noOfRecords' refers to count of leads to be returned per page.
'from_date' and 'to_date' are to be in yyyy-mm-dd hh:mm:ss(IST) format
Get Lost Lead Details : GET
URL : https://api.toolyt.com/get-lost-lead-details/{leadID}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"profilePicUrl": "https://toolyt.com/app/public/images/customer_pic/",
"photoUrl": "https://toolyt.com/app/public/images/customer_photos/",
"documentUrl": "https://toolyt.com/app/public/images/customer_documents/",
"lead": {
"lead_id": 423,
"full_name": "Ajay Bhalaria",
"company_name": "Walplast Products Pvt. Ltd.",
"designation": "Marketing Head",
"phone": "7738392983",
"alternate_phone": "",
"land_line": "",
"email": "ajay.bhalaria@walplast.com",
"address": "",
"website": "",
"profile_pic": "",
"location": "",
"country_name": "India",
"state_name": "Maharashtra",
"district_name": null,
"area_name": null,
"expected_value": 0,
"created_date": "2016-11-29 19:22:10",
"lead_status": "Competition",
"lead_source": "Cold Call",
"photos": {
"0": ""
},
"documents": {
"0": ""
},
"assigned_user_id": 27,
"assigned_user": "Nizamudheen V",
"industry": "Manufacturing",
"industry_category": null,
"industry_sub_category": null,
"no._of_fieldforce": "",
"distributor": "",
"description": "",
"pin_code": "",
"age": "",
"type": "",
"education": "",
}
}
apiKey : o9orfl4km83luxzd7vlt
This endpoint retrieves the details of a particular lead that is in lost stage.
Search Lead/Customer : POST
URL : https://api.toolyt.com/search-customer-or-lead?pageNumber=1&email={email}&noOfRecords=10&status=1
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
pageNumber: '1',
limit: '10',
status: '1',
email: 'steverasa@aab.com',
phone:'9847278434'
}
{
"status": 200,
"error": false,
"customer": {
"totalLeads": 1,
"customer": [
{
"customer_id": 14372,
"full_name": "Steve",
"company_name": "AAB Group",
"designation": "",
"phone": "9847278434",
"alternate_phone": "",
"land_line": "",
"email": "rasa@vv.com",
"address": "Hoodi Main Road, Hoodi Main Rd, Hoodi, Bengaluru, Karnataka, India",
"website": "",
"profile_pic": "20171213100645.png"
}
]
}
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
noOfRecords : No of data per page.
To search leads/customer/lost leads with email id or mobile number.
'pageNumber' indicates the number of pages and 'noOfRecords' refers to the number of records to be returned per page.
when 'status' is '0' it retrieves leads with matching phone number or email id
when 'status' is '1' it retrieves customers with matching phone number or email id
when 'status' is '2' it retrieves lost lead with matching phone number or email id
It's mandatory to pass 'email' or 'phone'.
Get Products : GET
URL : https://api.toolyt.com/get-products/{pageNumber}/{limit}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"productIconUrl": "https://toolyt.com/app/public/images/product_icon/",
"attachmentUrl": "https://toolyt.com/app/public/images/attachments/",
"total_products": 38,
"products": [
{
"product_id": 234,
"product_name": " Alcohol Swabs",
"product_sku": "KV-100P-AS",
"price": 55,
"description": "100/pack, PTD - 55, MRP - 400",
"product_icon": "20161030084338.jpg",
"attachments": "20161101000828.pdf",
"product_category": "KRIVIDA LANCETS, ALOCHOL SWABS & LANCING DEVICE",
"country_name": "India"
},
{
"product_id": 222,
"product_name": "ACD tube (1:4) ",
"product_sku": "KV-8.5ACD-V ",
"price": 11,
"description": "13x75, 600/C, 8.5, 11.00",
"product_icon": "20161030092151000000.PNG",
"attachments": "",
"product_category": "KRIVIDA VACUUM BLOOD COLLECTION TUBES",
"country_name": "India"
}
]
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
limit : No of products per page.
This endpoint retrieves products added in Toolyt. "pageNumber" in url is for defining page and limit is for defining numbers of products return per page. API will return total products count with all response.
Get Product Details : GET
URL : https://api.toolyt.com/get-product-details/{productId}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"productIconUrl": "https://toolyt.com/app/public/images/product_icon/",
"attachmentUrl": "https://toolyt.com/app/public/images/attachments/",
"product": {
"product_id": 234,
"product_name": " Alcohol Swabs",
"product_sku": "KV-100P-AS",
"price": 55,
"description": "100/pack, PTD - 55, MRP - 400",
"product_icon": "20161031084338.jpg",
"attachments": "20161101100828.pdf",
"product_category": "KRIVIDA LANCETS, ALOCHOL SWABS & LANCING DEVICE",
"country_name": "India",
"dimension": "NA",
"packaging": "100/Pack",
"volume_(ml)": "NA",
"mrp": "400"
}
}
apiKey : o9orfl4km83luxzd7vlt
This endpoint retrieves specific product details. "productId" in url specify "product_id" return in Get Products API.
Get Jobs : GET
URL : https://api.toolyt.com/get-jobs/{pageNumber}/{limit}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"jobImage": "https://toolyt.com/app/public/images/job_pic/",
"total_jobs": 54,
"jobs": [
{
"job_id": 2,
"reference_id": "TSFA_101",
"customer_id": 494,
"customer_name": "Sreejith",
"job_assign_to_user_id": 179,
"assign_to_user": "Amjad Ali U T ",
"job_type": 1,
"job_type_name": "Fix issue",
"product_id": null,
"product_name": null,
"purchase_date": "2016-09-04",
"warranty_date": "2017-09-03",
"finish_job_by_date": "2016-12-20 13:00:00",
"image": "20161206125759.png",
"job_status": "Issue solved"
},
{
"job_id": 3,
"reference_id": "TSFA_102",
"customer_id": 494,
"customer_name": "Sreejith",
"job_assign_to_user_id": 179,
"assign_to_user": "Amjad Ali U T ",
"job_type": 1,
"job_type_name": "Fix issue",
"product_id": null,
"product_name": null,
"purchase_date": "2016-12-06",
"warranty_date": "2016-12-06",
"finish_job_by_date": "2016-12-06 18:46:35",
"image": "",
"job_status": "Collected Machine"
}
]
}
apiKey : o9orfl4km83luxzd7vlt
pageNumber : Start from 1.
limit : No of jobs per page.
This endpoint retrieves jobs added in Toolyt. "pageNumber" in url is for defining page and limit is for defining numbers of jobs return per page. API will return total jobs count with all response.
Get Job Details : GET
URL : https://api.toolyt.com/get-job-details/{jobId}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"jobPhotos": "https://toolyt.com/app/public/images/job_photos/",
"jobImage": "https://toolyt.com/app/public/images/job_pic/",
"job": {
"job_id": 2,
"reference_id": "TSFA_101",
"customer_id": 494,
"customer_name": "Sreejith",
"job_assign_to_user_id": 179,
"assign_to_user": "Amjad Ali U T ",
"job_type": 1,
"job_type_name": "Fix issue",
"product_id": null,
"product_name": null,
"purchase_date": "2016-09-04",
"warranty_date": "2017-09-03",
"finish_job_by_date": "2016-12-20 13:00:00",
"job_details": "This is a test job",
"extra_task": "no extra task",
"alternate_phone": "",
"priority": "Medium",
"satisfaction": 0,
"completion_image": "",
"signature": "20170110074519.png",
"created_date": "2016-12-06 12:57:59",
"job_completion_status": "Not Completed",
"reopen_status": "",
"latitude": "",
"longitude": "",
"location_name": "",
"image": "20161206125759.png",
"photos": {
"0": "201612061257590.png",
"1": "201612061257591.png",
"2": "201612061257592.png"
},
"job_status": "Issue solved",
"finished_at": "2017-01-10 19:45:19",
"status_history": [
{
"job_status": "Issue solved",
"notes": "",
"comments": "",
"updated_by": 0,
"updated_user_name": "Admin",
"updated_date": "2017-01-10 19:45:19"
},
{
"job_status": "Reported issue",
"notes": "",
"comments": "",
"updated_by": 0,
"updated_user_name": "Admin",
"updated_date": "2016-12-06 12:57:59"
}
],
"reason": "",
"remarks": ""
}
}
apiKey : o9orfl4km83luxzd7vlt
This endpoint retrieves specific job details. "jobId" in url specify "job_id" return in Get Jobs API.
Note : Job image and completed image path are same.
Create Job : POST
URL : https://api.toolyt.com/create-job
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Job added successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-job HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"customer_id":96,
"created_by_user_id":4,
"job_details":"Testing new job",
"assign_to_user_id":4,
"extra_task":"NA",
"priority":"Low",
"purchase_date":"2013-12-12",
"warranty_date":"2016-01-01",
"finish_job_by_date":"2017-10-10 10:00:00",
"job_type":"JB Type 1",
"job_status":"pql",
"text_job1":"ddd",
"radio_job4":"val 1",
"check_test3":"b,d,c",
"image":"Base 64 Encoded Image",
"photos":[{"0":"Base 64 Encoded Image 1","1":"Base 64 Encoded Image 2"}]
}
This endpoint is to create job. Depends on form customization value passing to create job will vary. If any mandatory value not added or value format mismatch will return error. Data will pass as form data.
Pass token with api as field '_token'. assign_to_user_id set to 0 is job is not assigning to any one. If you need to add a job without any status send job_status filed 0. If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Create Schedule : POST
URL : https://api.toolyt.com/create-schedule
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Visit Scheduled successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-schedule HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"user_id":28,
"customer_lead_id": 2830,
"schedule_content":"Some content",
"schedule_date":2018-02-06,
"schedule_time":"20:55:00",
"schedule_user_id":"123"
}
This endpoint is to schedule a visit. Pass the user_id who has permissions to create schedule. Data will pass as form data.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the schedule content as per your requirement
Create Visit : POST
URL : https://api.toolyt.com/create-visit
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Visit added successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-visit HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"user_id":28,
"customer_lead_id": 2830,
"schedule_content":"Some content",
"schedule_date":2018-02-06,
"schedule_time":"20:55:00",
"schedule_user_id":"123",
"image":Base 64 Encoded Image,
"new_field2":dads,
"visit_mode_id":12,
"latitude":23.4343,
"longitude":17.232,
"check_in_time":20:55:00,
"check_out_time":20:56:01,
"reason_id":1,
"sub_reason_id":3,
"customer_status_type":0,
"lead_status_id":22,
"next_action_date":2018-02-07,
"next_action_time":10:55:00
}
This endpoint is to schedule a visit. Pass the user_id, customer/lead id who exists in your data. Data will pass as form data.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the visit mode id for which mode you want to add the visit. Pass the reason and sub reason id which you have in your data. Pass "0" as customer status type if its a lead and "1" if its a customer.
Pass the next action data and time if you want to schedule a visit for the customer/lead
View Visits : POST
URL : https://api.toolyt.com/view-visits?page_number=1&limit=10&from_date=yyyy-mm-dd hh:mm:ss&to_date=yyyy-mm-dd hh:mm:ss
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"Visits": [
[
{
"id": 2351,
"user_id": 27,
"first_name": "Nizamudheen",
"last_name": "V",
"address": "NA",
"phone": "1234567890",
"category_id": 11,
"user_assigned": 1,
"created_at": "2018-02-06 10:18:06",
"updated_at": "2018-02-06 10:18:06",
"company_id": 16,
"created_by": 27,
"customer_id": 2772,
"latitude": "",
"longitude": "",
"location_name": "",
"accuracy": "",
"visit_mode_id": null,
"remarks": "",
"schedule_content": "",
"date": "0000-00-00",
"time": "00:00:00",
"schedule_date": "07 Feb 2018",
"schedule_time": "10:55 AM",
"comments": "",
"next_action_date": "0000-00-00",
"next_action_time": "00:00:00",
"status": 0,
"cancel_reason": "",
"cancelled_user": null,
"cancelled_datetime": null,
"reschedule_status": 0,
"image": "",
"image_url": "",
"check_in_time": null,
"check_out_time": null,
"customer_contact_id": 0,
"customer_opportunity_id": 0,
"customer_opportunity_stage_id": 0,
"customer_status_type": 0,
"customer_progress_id": 0,
"reason_id": null,
"sub_reason_id": null,
"along_with_user": 0,
"order_added": 0,
"recurrence_added": 0,
"recurrence_id": null,
"user_name": "Nizamudheen V",
"full_name": "Dajumma",
"customer_name": "Customer name",
"customer_company": "Company",
"website": "",
"email": "",
"company_name": "Toolyt"
}
]
]
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/view-visits HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"userId":28,
"customerId": 2830,
"visitDate":2018-02-03,
"from_date":2022-03-01 19:08:06,
"to_date":2022-03-01 19:08:06,
}
This endpoint retrieves the visits for a specific date range from Toolyt.
'from_date' and 'to_date' are to be in yyyy-mm-dd hh:mm:ss format and both parameters are mandatory.
'page_number' indicates the number of pages and 'limit' indicates the number of entries per page.
Update Visit : POST
URL : https://api.toolyt.com/update-visits
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Visit added successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-visit HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"visit_id":2349,
"user_id":28,
"customer_lead_id": 2830,
"schedule_content":"Some content",
"schedule_date":2018-02-06,
"schedule_time":"20:55:00",
"schedule_user_id":"123",
"image":Base 64 Encoded Image,
"new_field2":dads,
"visit_mode_id":12,
"latitude":23.4343,
"longitude":17.232,
"check_in_time":20:55:00,
"check_out_time":20:56:01,
"reason_id":1,
"sub_reason_id":3,
"customer_status_type":0,
"lead_status_id":22
}
This endpoint is to schedule a visit. Pass the user_id, customer/lead id who exists in your data. Data will pass as form data. Pass the existing visit id retrieved from the scheduled visits.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the visit mode id for which mode you want to add the visit. Pass the reason and sub reason id which you have in your data. Pass "0" as customer status type if its a lead and "1" if its a customer.
Pass the next action data and time if you want to schedule another visit for the customer/lead
Cancel Visit : POST
URL : https://api.toolyt.com/cancel-visits
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Visit cacnelled successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/cancel-visit HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"visit_id":2349,
"user_id":28,
"cacncel_reason": "Some reason"
}
This endpoint is to schedule a visit. Pass the user_id, customer/lead id who exists in your data. Data will pass as form data. Pass the existing visit id retrieved from the scheduled visits.
Pass token with api as field '_token'.
Orders : POST
URL : https://api.toolyt.com/get-orders
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
pageNumber:1
limit:5
startDate:2020-12-08
endDate:2021-01-20
}
{
"status": 200,
"error": false,
"order": {
"totalOrders": 71,
"orders": [
{
"order_no": "71_7112",
"order_id": 224557,
"customer_code": 2012438,
"customer_type": "Customer",
"order_date": "2021-01-20 20:33:10",
"default_price": 14400,
"product_details": [
{
"product_name": "Beados",
"product_sku": "Beados",
"description": "Test",
"price": 1200,
"quantity": 12,
"stock": 0,
"product_codes": null
}
]
},
{
"order_no": "63_6616",
"order_id": 223179,
"customer_code": 562971,
"customer_type": "Customer",
"order_date": "2020-12-08 16:48:02",
"default_price": 2400,
"product_details": [
{
"product_name": "Beados",
"product_sku": "Beados",
"description": "Test",
"price": 1200,
"quantity": 2,
"stock": 0,
"product_codes": null
}
]
}
]
}
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/get-orders HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: 116ov7jj0ce21kbygqpo
Content-Type: application/json
{
pageNumber:1
limit:5
startDate:2020-12-08
endDate:2021-01-20
}
This API is for retrieving orders."startDate" and "endDate" in the format YYYY-MM-DD are for filtering orders in a date range."pageNumber" is for defining page and "limit" is for defining numbers of orders return per page. API will return total orders count with all response.
Order Invoice List : GET
URL : https://api.toolyt.com/get-order-invoices/{page number}/{No of data in page}/{date}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"total": 3,
"data": [
{
"invoice_id": 181345,
"invoice_number": "INVOICE#16_6616",
"invoice_date": "2019-05-09",
"invoice_due_date": "2019-05-19",
"credit_level": null,
"credit_priod": null,
"customer_id": 418892,
"customer_name": "Cvh(Cvh)",
"amount": 4000,
"tax": 10,
"total_amount": 4010,
"balance_amount": 4010,
"status": "Open"
},
{
"invoice_id": 181318,
"invoice_number": "INVOICE#15_6616",
"invoice_date": "2019-05-09",
"invoice_due_date": "2019-05-19",
"credit_level": null,
"credit_priod": null,
"customer_id": 418892,
"customer_name": "Cvh(Cvh)",
"amount": 5000,
"tax": 0,
"total_amount": 5000,
"balance_amount": 0,
"status": "Paid"
}
]
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/get-order-invoices/1/10/2018-10-20 HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
Date is not mandatory. API will return the invoices created from the date which is specified in API. If not passing date in API, then it will return complete data in the system.
Invoice Id is unique for each invoice, this value can be used for calling order invoice details API.
Pass token with api as field '_token'.
Order Invoice Details : GET
URL : https://api.toolyt.com/get-order-invoice-details/{order invoice Id}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"invoice": {
"invoice_id": 181318,
"invoice_number": "INVOICE#15_6616",
"invoice_date": "2019-05-09",
"invoice_due_date": "2019-05-19",
"credit_level": null,
"credit_priod": null,
"customer_id": 418892,
"customer_name": "Cvh(Cvh)",
"customer_address": "",
"country": null,
"state": null,
"city": null,
"area": null,
"amount": 5000,
"tax": 0,
"total_amount": 5000,
"balance_amount": 0,
"status": "Paid",
"products": [
{
"id": 209698,
"product_name": "ICP",
"product_sku": "2569",
"quantity": 2,
"free_quantity": 0,
"price_per_quantity": 1500,
"tax_amount": 0
},
{
"id": 209699,
"product_name": "ICP Version2",
"product_sku": "2589",
"quantity": 1,
"free_quantity": 0,
"price_per_quantity": 2000,
"tax_amount": 0
}
]
}
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/get-order-invoice-details/112333 HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
This API is for getting details of order invoice. Pass order invoice Id which is getting in order invoice listing
Pass token with api as field '_token'.
Attendence List: POST
URL : https://api.toolyt.com/get-attendence?page_number=1&limit=10&from_date=YYYY-MM-DD&to_date=YYYY-MM-DD
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"attendenceListCount": 8,
"attendenceList": [
{
"user_id": 27,
"full_name": "Nizamudheen ",
"date": "2022-03-01",
"latitude": "12.901022",
"longitude": "77.6448964",
"location_name": "HSR Layout, Bengaluru, Karnataka, India",
"signin_time": "18:04:09",
"signout_time": "18:04:41",
"logout_location_name": "HSR Layout, Bengaluru, Karnataka, India",
"created_at": "2022-03-01 18:04:09"
},
{
"user_id": 27,
"full_name": "Nizamudheen ",
"date": "2022-03-01",
"latitude": "12.9010219",
"longitude": "77.644894",
"location_name": "HSR Layout, Bengaluru, Karnataka, India",
"signin_time": "16:24:57",
"signout_time": "16:51:38",
"logout_location_name": "",
"created_at": "2022-03-01 16:24:57"
},
{
"user_id": 27,
"full_name": "Nizamudheen ",
"date": "2022-03-01",
"latitude": "12.9009136",
"longitude": "77.6448357",
"location_name": "3rd Main Road, HSR Layout, Bengaluru, Karnataka, India",
"signin_time": "14:31:44",
"signout_time": "23:59:02",
"logout_location_name": "",
"created_at": "2022-03-01 14:31:44"
},
]
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/get-attendence?page_number=1&limit=10 HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
This endpoint retrieves the attendance entries of users for a specific date range.
'from_date' and 'to_date' are to be in YYYY-MM-DD format and both parameters are mandatory.
'page_number' indicates the number of pages and limit indicates the number of entries per page.
Get Opportunities : GET
URL : https://api.toolyt.com/get-opportunities/{pageNumber}/{limit}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"baseUrl": "http://localhost/toolyt_api_2022",
"total_leads": 2,
"leads": [
{
"toolyt_oppurtunity_id": 38,
"oppurtunity_name": "Jobin Opp",
"reference_id": "114",
"company_name": "Concorde group",
"full_name": "Sreerag SS",
"prospect_type": "1",
"user_name": "Amjad Ali U T",
"distributor_status": 0,
"created_by": 179,
"customer_id": 34,
"status_type": 1,
"created_at": "2017-05-24 13:04:15",
"lost_won_status": 0,
"currency_id": null,
"opportunity_notes_count": 2,
"external_id": null,
"cancelled_status": 0,
"estimated_order_date": "2017-07-02",
"currency_symbol": null,
"estimated_order_value": "0.00",
"oppurtunity_stage": "Stage 1"
},
{
"toolyt_oppurtunity_id": 39,
"oppurtunity_name": "Sreeju Opp",
"reference_id": "115",
"company_name": "Estia",
"full_name": "Rajeev",
"prospect_type": "1",
"user_name": "Amjad Ali U T",
"distributor_status": 0,
"created_by": 179,
"customer_id": 474,
"status_type": 0,
"created_at": "2017-05-24 13:04:51",
"lost_won_status": 0,
"currency_id": null,
"opportunity_notes_count": 0,
"external_id": null,
"cancelled_status": 0,
"estimated_order_date": "2017-07-02",
"currency_symbol": null,
"estimated_order_value": "0.00",
"oppurtunity_stage": "Stage 5"
}
]
}
POST /get-opportunities/{pageNumber}/{limit}?from_date=2017-05-23 13:04:51&to_date=2017-05-24 23:59:59&user_id=179 HTTP/1.1
Host: https://api.toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
Get Opportunity Details : GET
URL : https://api.toolyt.com/get-opportunity-details/{opportunityID}
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status": 200,
"error": false,
"opportunity": {
"toolyt_oppurtunities_id": 95,
"oppurtunity_type": "Type 1",
"estimated_order_date": "2021-12-17",
"lost_won_status": 0,
"cancelled_status": 0,
"reference_id": "TOOLYT2021140",
"lost_won_date": "2021-12-25",
"lost_won_reason": "LOST/WON REASON",
"customer_id": 291555,
"last_stage_id": 1,
"oppurtunity_name": "OPPORTUNITY NAME",
"company_id": 165,
"created_by": 277,
"created_at": "2021-12-10 09:26:47",
"forecast_category_id": 125,
"forecast_category": "FORECAST CATEGORY",
"company_name": "COMPANY NAME",
"full_name": "FULL NAME",
"prospect_type": null,
"user_name": "USER NAME ",
"estimated_order_value": "500000.00",
"currency_symbol": "₹",
"currency_short_name": "INR",
"oppurtunity_step": "Initial Contact",
"distributor_status": 0,
"status_type": 1,
"dtp_sum": "50.00",
"selling_model": 1,
"opportunity_category": 1,
"opportunity_created_person_id": 277,
"created_distributor_status": 0,
"created_user_name": "USER NAME",
"customer_push_status": 0,
"customer_external_id": "1234a56789bc0DeFGH"
}
}
apiKey : o9orfl4km83luxzd7vlt
Create Opportunity : POST
URL : https://api.toolyt.com/create-opportunity
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Opportunity added successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/create-opportunity HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"created_by_user_id":27,
"customer_id":2911,
"opportunity_created_person_id":27,
"opportunity_name":"Test_API123",
"lost_won_reason":"Test lost_won_reason",
"estimated_order_date":"2022-03-23",
"estimated_order_value":"100000",
"oppurtunity_step_id":"25",
"currency_id":"1",
"forecast_category_id":"2",
"function_to_call":"",
"productSelectedAll":"",
"productSelectedCategory":"",
"products":
{
"62492":
{
"product_id":"62492",
"quantity":1,
"price":"75000"
},
"62495":
{
"product_id":"62495",
"quantity":2,
"price":"80000"
}
}
}
This endpoint lets you create an opportunity against a lead or customer in Toolyt.
created_by_user_id (*) -Toolyt id of 'Created by user'
customer_id (*)-Toolyt id of lead or customer
opportunity_created_person_id (*)-Toolyt id of 'Created by user'
opportunity_name (*)-Name of opportunity
products (if product_mandatory is enabled in toolyt_opportunity_customisations) -Product ids
estimated_order_date - Close date of opportunity
estimated_order_value - Order value of opportunity
oppurtunity_step_id - Toolyt id of opportunity stage
forecast_category_id - Toolyt id of opportunity forecast type
(*) = Mandatory Fields.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the assigned_to_id products as an array.
Update Opportunity : POST
URL : https://api.toolyt.com/update-opportunity
{
AuthorizationKey: apiKey
}
Make sure to replace apiKey with key generated in Toolyt api module.
{
"status":200,
"error":false,
"message":"Opportunity updated successfully."
}
If there is any error, it will return error as true and send error message in 'message' value.
POST api/update-opportunity HTTP/1.1
Host: https://toolyt.com
AuthorizationKey: o0orfl4km83luxzd7vlt
Content-Type: application/json
{
"opportunity_id":125,
"created_by_user_id":27,
"customer_id":2911,
"opportunity_created_person_id":27,
"opportunity_name":"Test_API123",
"lost_won_reason":"Test lost_won_reason",
"estimated_order_date":"2022-03-23",
"estimated_order_value":"100000",
"oppurtunity_step_id":"25",
"currency_id":"1",
"forecast_category_id":"2",
"function_to_call":"",
"productSelectedAll":"",
"productSelectedCategory":"",
"products":
{
"62492":
{
"product_id":"62492",
"quantity":1,
"price":"75000"
},
"62495":
{
"product_id":"62495",
"quantity":2,
"price":"80000"
}
}
}
This endpoint lets you update an opportunity.
opportunity_id (*) - Id of the opportunity needs to be updated
created_by_user_id -Toolyt id of 'Created by user'
customer_id -Toolyt id of lead or customer
lost_won_status - Opportunity won/lost status
opportunity_created_person_id -Toolyt id of 'Created by user'
opportunity_name -Name of opportunity
products (if product_mandatory is enabled in toolyt_opportunity_customisations) -Product ids
estimated_order_date - Close date of opportunity
estimated_order_value - Order value of opportunity
oppurtunity_step_id - Toolyt id of opportunity stage
forecast_category_id - Toolyt id of opportunity forecast type
(*) = Mandatory Fields.
Pass token with api as field '_token'.If custom field is check box, send value as comma(,) separated list. Photos and images are base 64 encoded values.
Pass the assigned_to_id products as an array.
Errors
The Kittn API uses the following error codes:
| Error Code | Meaning |
|---|---|
| 400 | Bad Request – Your request sucks |
| 401 | Unauthorized – Your API key is wrong |
| 500 | Internal Server Error – We had a problem with our server. Try again later. |
| 503 | Service Unavailable – We’re temporarially offline for maintanance. Please try again later. |