1Add New Emergency Category
API Url :
API's Method Type :
POST
Description :
To add a new emergency contact category to add the emergency contacts in that created category.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"emergencycategoryname":"newtest"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
2Reducing Subscription Quantity
API Url :
API's Method Type :
POST
Description :
Reduce the staff licensing for the unwanted subscription.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"deactivatesubscription":"1"
}
Sample Response
{
"status_code": 1,
"message": "You have successfully Reduced 1 staff license.",
"data": ""
}
3Cancel Subscription
API Url :
API's Method Type :
POST
Description :
Here we can able to cancel the subscription detail.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1"
}
Sample Response
{
"status_code": 1,
"message": "You Have Successfully Cancelled Your Subscription plan. Thanks, for subscription.",
"data": ""
}
4Resume Subscription
API Url :
API's Method Type :
POST
Description :
Here resumes the subscription plan which we have canceled.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1"
}
Sample Response
{
"status_code": 1,
"message": "You have successfully resumed your subscription",
"data": ""
}
5Get Timeclock Entries
API Url :
API's Method Type :
POST
Description :
To get the company staff time clock entries that they have entered.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 09:18:50",
"endTime": "2020-03-26 11:19:51",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 2
},
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 11:26:43",
"endTime": "2020-03-26 11:30:33",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 0
},
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 11:30:34",
"endTime": "2020-03-26 11:41:45",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 0
}
]
}
6Search Time Clock Entry
API Url :
API's Method Type :
POST
Description :
The time clock entries can be filtered between the two dates we entered.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"startdate":"03/25/2020",
"enddate":"03/26/2020"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 09:18:50",
"endTime": "2020-03-26 11:19:51",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 2
},
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 11:26:43",
"endTime": "2020-03-26 11:30:33",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 0
},
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 11:30:34",
"endTime": "2020-03-26 11:41:45",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 0
},
{
"id": 1,
"userId": 1,
"startTime": "2020-03-26 12:44:08",
"endTime": "2020-03-26 12:44:31",
"comments": null,
"IsDelete": 0,
"created_at": null,
"updated_at": null,
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin",
"email": "testmail5210@gmail.com",
"firstname": "Chevol",
"lastname": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"timezoneOffset": -5,
"dst": 1,
"userPic": "userDefault.png",
"hours": 0
}
]
}
7User Password Change
API Url :
API's Method Type :
POST
Description :
To change the user's password by using this API
Headers as params :
api_token : < user's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1",
"currentpassword": "test123",
"password": "test1234",
"password_confirmation": "test1234"
}
Sample Response
{
"status_code": 1,
"message": "Password Changed Successfully",
"data": ""
}
8Create Feedback
API Url :
API's Method Type :
POST
Description :
To create new feedback and submit it to the company.
Headers as params :
api_token : < user's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1",
"title": "Testing",
"type": "1",
"description": "Testing Description"
}
Sample Response
{
"status_code": 1,
"message": "Successfully Submitted Your feedback. Thank you for helping us make MyEbaj better!",
"data": ""
}
9Feedback types
API Url :
API's Method Type :
POST
Description :
To get the feedback types from the company created and give to a feedback form.
Headers as params :
api_token : < user's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"type": "test",
"created_at": null,
"updated_at": null
}
]
}
10List all emergency category
API Url :
API's Method Type :
POST
Description :
To list all the emergency contact categories of that company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"name": "test",
"companyId": 3,
"isDeleted": 0,
"created_at": "2020-04-03 11:36:46",
"updated_at": "2020-07-03 06:31:10"
},
{
"id": 2,
"name": "tests",
"companyId": 3,
"isDeleted": 0,
"created_at": "2020-07-03 06:31:50",
"updated_at": "2020-07-04 07:23:42"
},
{
"id": 3,
"name": "newtest",
"companyId": 3,
"isDeleted": 0,
"created_at": "2020-07-03 11:11:33",
"updated_at": "2020-07-03 11:11:33"
}
]
}
11Adding Subscription Quantity
API Url :
API's Method Type :
POST
Description :
If we need to add staff we need to increment the subscription plan.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1",
"add_subcription": "1"
}
Sample Response
{
"status_code": 1,
"message": "You have successfully subscribed 1 staff license.",
"data": ""
}
12Get Individual Emergency Category
API Url :
API's Method Type :
POST
Description :
To get the detail of individual emergency contact category
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"categoryId":"3"
}
Sample Response
{
"status_code": 1,
"message": "success",
"data": {
"id": 3,
"name": "default category",
"isDeleted": 0,
"created_at": "2020-07-03 11:11:33",
"updated_at": "2020-07-03 11:11:33"
}
}
13Update a emergency category detail
API Url :
API's Method Type :
POST
Description :
To update the emergency category detail.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"categoryId":"2",
"emergencycategoryname":"test category"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
14Deactivate Emergency Category
API Url :
API's Method Type :
POST
Description :
This is to deactivate the emergency category not to display in the emergency contacts list.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1",
"categoryId":"2"
}
Sample Response
{
"status_code": 1,
"message": "Emergency Category Successfully Deactivated",
"data": ""
}
15Activate Emergency Category
API Url :
API's Method Type :
POST
Description :
To activate the emergency category to show the category list in emergency contact details.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"categoryId":"2"
}
Sample Response
{
"status_code": 1,
"message": "Emergency Category Successfully Activated",
"data": ""
}
16List all emergency Numbers of Company
API Url :
API's Method Type :
POST
Description :
To get all the emergency contact numbers added by a company admin.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"name": "Sales Manager",
"number": "+1 4561425789",
"companyId": 1,
"categoryId": 1,
"sortNumber": null,
"isDeleted": 0,
"created_at": "2020-11-24 09:19:39",
"updated_at": "2020-11-24 09:19:39",
"category": {
"id": 1,
"name": "Sales",
"companyId": 2,
"isDeleted": 0,
"created_at": "2020-04-03 11:36:46",
"updated_at": "2020-07-03 06:31:10"
}
},
{
"id": 2,
"name": "Help Manager",
"number": "+1 5689745635",
"companyId": 1,
"categoryId": 1,
"sortNumber": null,
"isDeleted": 0,
"created_at": "2020-11-25 09:19:39",
"updated_at": "2020-11-25 09:19:39",
"category": {
"id": 1,
"name": "Help Desk",
"companyId": 2,
"isDeleted": 0,
"created_at": "2020-04-04 11:36:46",
"updated_at": "2020-07-04 06:31:10"
}
}
]
}
17Get Individual Emergency Number
API Url :
API's Method Type :
POST
Description :
To get the detail of the individual emergency contact number.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"emergencyId": 2
}
Sample Response
{
"status_code": 1,
"message": "success",
"data": {
"id": 2,
"name": "Emergency Staff Name India",
"number": "+91 9977894561",
"companyId": 2,
"categoryId": 1,
"sortNumber": null,
"isDeleted": 0,
"created_at": "2020-04-03 12:18:49",
"updated_at": "2020-08-14 07:14:00"
},
"category": {
"id": 1,
"name": "test",
"companyId": 2,
"isDeleted": 0,
"created_at": "2020-04-03 11:36:46",
"updated_at": "2020-07-03 06:31:10"
}
}
18Add New Emergency Number
API Url :
API's Method Type :
POST
Description :
To add a new emergency contact to a company
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"emergencyname":"Customer Support",
"emergencynumber":"+1 4567894561",
"emergencycategory":"3"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
19To Update a Emergency detail
API Url :
API's Method Type :
POST
Description :
To update a particular emergency contact detail.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"emergencyname":"Sales Agent",
"emergencynumber":"+1 7894567894",
"emergencycategory":"3",
"emergencyId":"8"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
20Staff Activation
API Url :
API's Method Type :
POST
Description :
To activate a deactivated staff in the company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"staffId":"2"
}
Sample Response
{
"status_code": 0,
"message": "Successfully Activated",
"data": ""
}
21Get A Company Profile
API Url :
API's Method Type :
POST
Description :
To get your company profile
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID" : "1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"name": "Clemons Harper Trading",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"email": "clemons@harper.com",
"hexColor": "#1F3B51",
"rgbColor": null,
"companyLogo": "defaultCompany.png",
"active": 1,
"created_at": "2020-03-05 07:44:04",
"updated_at": "2020-03-05 07:44:31"
}
]
}
22Update A Company Profile
API Url :
API's Method Type :
POST
Description :
To updating a company profile details.
Headers as params :
api_company_token : < company's token >
Request and Response Sample
Sample Request
{
"userID":"1",
"name":"Clemons Harper Trading",
"email":"clemons@harper.com",
"hexColor":"#1F3B51",
"address1":"128, Salt Lake",
"address2":"West Salem",
"state":"AR",
"zip":"54669",
"phone":"517-905-2528"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
23Get User Profile
API Url :
API's Method Type :
POST
Description :
To get the user's profile details to view their profile.
Headers as params :
api_token : < user's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": {
"firstName": "Chevol",
"lastName": "Davis",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"phone": null,
"email": "testmail5210@gmail.com",
"timezoneOffset": -5,
"dst": 1,
"profileImage": "userDefault.png"
}
}
24Update A User Profile
API Url :
API's Method Type :
POST
Description :
Profile update for the logged-in user's profile details.
Headers as params :
api_token : < user's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"firstName": "Chevol",
"lastName": "Davis",
"address1": "123,lake street",
"address2": "Winston-salem",
"city": "Orionto",
"state": "Texas",
"zip": "54564",
"phone": "7845147526",
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
25Company's Staff List
API Url :
API's Method Type :
POST
Description :
To get all the staff lists of a particular company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 0,
"message": "Success",
"data": [
{
"id": 1,
"name": "Clemons Harper Trading",
"address1": "128, Salt Lake",
"address2": "West Salem",
"city": null,
"state": "AR",
"zip": 54669,
"phone": "517-905-2528",
"email": "testmail5210@gmail.com",
"hexColor": "#1F3B51",
"rgbColor": null,
"companyLogo": "defaultCompany.png",
"active": 1,
"created_at": null,
"updated_at": null,
"firstname": "Chevol",
"lastname": "Davis",
"userPic": "userDefault.png",
"userID": 1,
"companyID": 1,
"isAdmin": 1,
"isPrimary": 1,
"isOwner": 1,
"selectedCompany": 1,
"position": "Company Admin"
},
{
"id": 2,
"name": "Clemons Harper Trading",
"address1": "128, Salt Lake",
"address2": "West Salem",
"city": null,
"state": "AR",
"zip": 54669,
"phone": "517-905-2528",
"email": "smithwilliams@mail.com",
"hexColor": "#1F3B51",
"rgbColor": null,
"companyLogo": "defaultCompany.png",
"active": 1,
"created_at": "2020-03-06 07:52:18",
"updated_at": "2020-03-06 07:52:18",
"firstname": "Smith",
"lastname": "Williams",
"userPic": "userDefault.png",
"userID": 2,
"companyID": 1,
"isAdmin": 0,
"isPrimary": 1,
"isOwner": 0,
"selectedCompany": 1,
"position": "AGL"
}
],
"profilecompleteness": {
"0": 50,
"1": 50
}
}
26Add A New Staff To Company
API Url :
API's Method Type :
POST
Description :
To add new staff to that company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"firstname":"Roy",
"lastname":"Crige",
"email":"roymobie@mailinator.com",
"position":"APL",
"address1":"12,west land",
"address2":"summerset",
"city":"Texas",
"state":"AL",
"zip":"54862",
"phone":"4564758965"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
27Get an Individual Staff Detail
API Url :
API's Method Type :
POST
Description :
To get an individual staff detail of that company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"staffId":"2"
}
Sample Response
{
"status_code": 1,
"message": "success",
"data": {
"id": 2,
"name": "Clemons Harper Trading",
"address1": "102,Salt Lake",
"address2": null,
"city": "Orion",
"state": "AL",
"zip": 145254,
"phone": "5895475856",
"email": "williamsmith@mail.com",
"hexColor": "#1F3B51",
"rgbColor": null,
"companyLogo": "defaultCompany.png",
"active": 1,
"created_at": "2020-03-06 07:52:18",
"updated_at": "2020-03-06 07:52:18",
"firstname": "Smith",
"lastname": "William",
"userPic": "userDefault.png",
"userID": 2,
"companyID": 1,
"isAdmin": 0,
"isPrimary": 1,
"isOwner": 0,
"selectedCompany": 1,
"position": "AGL"
}
}
28Update A Staff Detail
API Url :
API's Method Type :
POST
Description :
To update the details of the particular staff in a company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"staffid":"2",
"firstname":"Kevin",
"lastname":"Peter",
"email":"kpeter@mailinator.com",
"position":"AGL",
"address1":"102,Salt Lake",
"address2":"WSalem",
"city":"Orion",
"state":"AR",
"zip":"145254",
"phone":"5895475856"
}
Sample Response
{
"status_code": 1,
"message": "Successfully Updated",
"data": ""
}
29Login
API Url :
API's Method Type :
POST
Description :
This API url is used to authenticate the valid user.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"user_email":"test@mail.com",
"user_password":"*******"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": {
"id": 1,
"email": "test@mail.com",
"role": "User",
"active": 1,
"api_token": "52d531b36d2295af856b37013487ca9b1ebe039f",
"api_company_token": "xxxxxxxxxx.xxxxx-xxxxxxxxxxeg0asm-lmcpta51mc@eo",
"lastLogin": "Wed, 11 Mar 2020 05:50:55 UTC",
"updated_at": "Wed, 11 Mar 2020 05:50:55 UTC",
"created_at": "Thu, 05 Mar 2020 13:14:04 UTC",
"stripe_id": "cus_GqypMxktlD0deV",
"card_brand": "Visa",
"card_last_four": "4242",
"trial_ends_at": null,
"firstname": "Robert",
"lastname": "Smith",
"IscompanyAdmin": 1
}
}
30Staff Deactivate
API Url :
API's Method Type :
POST
Description :
To deactivate the staff of that company to no more participate in its functionality. Only activated staff can be deactivated.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"staffId":"2"
}
Sample Response
{
"status_code": 1,
"message": "Successfully Deactivated",
"data": ""
}
31Add Staff Subscription Enable
API Url :
API's Method Type :
POST
Description :
If staff need to add means we need to enable the subscription button. If the quantity of subscriptions is equal to staff count we need to show the add subscription button.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Staff Button",
"activeemployeescount": 2,
"subscription_details": {
"id": 1,
"user_id": 1,
"name": "Basic-Access",
"stripe_id": "sub_GqypJii9Rvrfp8",
"stripe_plan": "Basic-Access",
"quantity": 2,
"trial_ends_at": null,
"ends_at": null,
"created_at": "2020-03-05 10:24:19",
"updated_at": "2020-03-06 08:09:49"
}
}
32Company's Contact List
API Url :
API's Method Type :
POST
Description :
To get all the contacts in that company then only an assigned staff from a company meets contact/client person to get a signature and geographical location from them.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 1,
"companyID": 1,
"uniqueID": null,
"firstname": "Mikes",
"lastname": "Tyson",
"position": "Tester",
"active": 1,
"created_at": null,
"updated_at": "2020-03-06 07:40:33"
},
{
"id": 2,
"companyID": 1,
"uniqueID": null,
"firstname": "steve",
"lastname": "Jobs",
"position": "Trainee",
"active": 1,
"created_at": "2020-03-06 07:09:17",
"updated_at": "2020-03-06 07:12:04"
}
]
}
33Adding a New Contact
API Url :
API's Method Type :
POST
Description :
To add new contact details by the company admin of that company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"firstname":"michael",
"lastname":"Jo",
"position":"Developer",
"staffid[]":"1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": ""
}
34Get Individual Contact Detail
API Url :
API's Method Type :
POST
Description :
To get the details of individual contact of that company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"contactId":"3"
}
Sample Response
{
"status_code": 1,
"message": "success",
"data": {
"id": 3,
"companyID": 1,
"uniqueID": null,
"firstname": "michael",
"lastname": "Jo",
"position": "Developer",
"active": 1,
"created_at": "2020-03-25 05:31:59",
"updated_at": "2020-03-25 05:31:59"
},
"staffs": []
}
35Update A Contact Detail
API Url :
API's Method Type :
POST
Description :
To update details of particular contact detail in that company.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"contactId":"3",
"firstname":"Michael",
"lastname":"Jo",
"position":"Developer",
"assigned[]":"2",
"uniqueid":"Michaeldevelop"
}
Sample Response
{
"status_code": 1,
"message": "Successfully Updated",
"data": ""
}
36Contact Deactivate
API Url :
API's Method Type :
POST
Description :
To deactivate those contact of the company after the assigned staff get signature from was already the contacts created.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID":"1",
"contactId":"3"
}
Sample Response
{
"status_code": 1,
"message": "Contact Successfully Deactivated",
"data": ""
}
37To Show Billing Details
API Url :
API's Method Type :
POST
Description :
Show the Company's All subscription Details.
Headers as params :
api_company_token : < company's token >
Content-Type : application/json
Request and Response Sample
Sample Request
{
"userID": "1"
}
Sample Response
{
"status_code": 1,
"message": "Success",
"data": [
{
"id": 2,
"user_id": 1,
"name": "API-Service",
"stripe_id": "sub_Gr1iazkfjOgnAS",
"stripe_plan": "API-Service",
"quantity": 1,
"trial_ends_at": null,
"ends_at": null,
"created_at": "2020-03-05 13:23:10",
"updated_at": "2020-03-05 13:23:10"
},
{
"id": 1,
"user_id": 1,
"name": "Basic-Access",
"stripe_id": "sub_GqypJii9Rvrfp8",
"stripe_plan": "Basic-Access",
"quantity": 2,
"trial_ends_at": null,
"ends_at": null,
"created_at": "2020-03-05 10:24:19",
"updated_at": "2020-03-06 08:09:49"
}
],
"invoice": {
"0": "/user/invoice/in_1GJJfLByRlgDxjmyCQcmgKLF",
"1": "/user/invoice/in_1GJGsHByRlgDxjmytvSpc1O9"
}
}
Note : The Company's token or user token not only included in heades param as well we can pass information via raw data or form data.