The REST API provides an easy-to-use set of HTTP endpoints that let you access your site’s data in simple JSON format, including users, leads, taxonomies and more. Retrieving or updating data is as simple as sending a HTTP request.
The web services help you build applications and manage your CRM Account and the associated CRM data using CRM REST API. FinCRM APIs belongs to the REST (Representational State Transfer) category. The REST methods include: GET, POST, PUT and DELETE request.
| Request Methods |
Definition |
| GET |
Fetching the data or retrieve the data |
| POST |
Store the data |
| PUT |
Updating the data |
| DELETE |
Destroy Or Deleting the data |
Note: {URL}:
| Key |
Value |
| Content-Type |
application/json |
User Authentication:
- Login User:
Method: POST
URL: {url}/api/login
Headers: key: Content-Type value: application/json
Body Params: email, password
- Register User:
Method: POST
URL: {url}/api/register
Headers: key: Content-Type value: application/json
Body Params: name, email, mobile, company, password, c_password
| Body params |
Data type |
Message |
| name |
String |
Your name |
| email |
Email |
Your email |
| mobile |
Integer |
Your contact number |
| company |
String |
Your company name |
| password |
String |
Your password |
| c_password |
String |
Your confirm password |
- Logout:
Method: POST
URL: {url}/api/logout
Headers:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Company: Except all companies and company details, you will need the auth_token or Authorization Header for accessing the company API’s
- All Companies
Method: GET
URL: {url}/api/ v1/companies?sort={number}
Headers: key: Content-Type value: application/json
Params: key: sort , value: enter integer value such as 10, 25 etc..
The sort params will return you a number of record you wants to lists.
- Company Details
Method: GET
URL: {url}/api/ v1/companies/{slug}
Headers: key: Content-Type value: application/json
- Add Company
Method: POST
URL: {url}/api/ v1/companies
Headers:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Body params:
| Body params |
Data type |
Message |
| c_name |
String |
Your company name |
| c_mobileNum |
number |
Your company number |
| c_whatsappNum |
number |
Your whatsapp number |
| c_bio |
String |
Your company bio |
| c_email |
String |
Your company email |
| personal_name |
String |
Your name |
| category_id |
Integer |
Integer value of category |
| actype_id |
Integer |
Account type id |
| position |
String |
Your position in company |
| c_logo |
image |
Company logo |
- Update Company
Method: PUT
URL: {url}/api/ v1/companies/{slug}
Headers:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Body params:
| Body params |
Data type |
Message |
| c_name |
String |
Your company name |
| c_mobileNum |
number |
Your company number |
| c_whatsappNum |
number |
Your whatsapp number |
| c_bio |
String |
Your company bio |
| c_email |
String |
Your company email |
| personal_name |
String |
Your name |
| category_id |
Integer |
Integer value of category |
| actype_id |
Integer |
Account type id |
| position |
String |
Your position in company |
| c_logo |
image |
Company logo |
- Delete Company
Method: DELETE
URL: {url}/api/ v1/companies/{slug}
Headers:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- Auth User Company
Method: GET
URL: {url}/api/ v1/auth/company?limit={number}
Headers:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Params: key: limit value: number (number like 5,10,50 etc…)
This limit params will return number of companies you want to lists.
Products:
- Lists of products
Method: GET
URL: {url}/api/v1/products?unique=false&sort=18&featured=true
Headers: key: Content-Type value: application/json
Params:
| Key |
Value |
Message |
| unique |
true/false |
List only one product of each users. |
| sort |
Number (10, 20) |
Enter number to lists the product |
| Featured |
true/false |
If true will return featured product otherwise all product |
- Product details
Method: GET
URL: {url}/api/v1/products/{slug}
Headers: key: Content-Type value: application/json
- Add product
Method: POST
URL: {url}/api/v1/products
Headers: key:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Params:
| Body params |
Data type |
Message |
| name |
String |
Your product name |
| price |
number |
Your product price |
| description |
Text |
Your product description |
| procat_id |
Int |
Select product category |
| prosubcat_id |
Int |
Select product subcategory |
| company |
Int |
Select company |
| vendor |
String |
Enter vendor |
| tags |
String |
Enter tags |
| location |
String |
Enter location |
| min_quantity |
Int |
Enter min quantity of product |
| picture |
Image |
Upload file |
| unit |
Int |
Enter unit of product |
- Update product
Method: PUT
URL: {url}/api/v1/products/{slug}
Headers: key:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Params:
| Body params |
Data type |
Message |
| name |
String |
Your product name |
| price |
number |
Your product price |
| description |
Text |
Your product description |
| procat_id |
Int |
Select product category |
| prosubcat_id |
Int |
Select product subcategory |
| company |
Int |
Select company |
| vendor |
String |
Enter vendor |
| tags |
String |
Enter tags |
| location |
String |
Enter location |
| min_quantity |
Int |
Enter min quantity of product |
| picture |
Image |
Upload file |
| unit |
Int |
Enter unit of product |
- Delete product
Method: DELETE
URL: {url}/api/v1/products/{slug}
Headers: key:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- Product lead store
Method: POST
URL: {url}/api/v1/product/leads
Headers: key:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Params:
| Body params |
Data type |
Message |
| first_name |
String |
name |
| email |
String |
Email |
| mobile |
Number |
Number |
| pro_id |
Int |
Select product id |
| notes |
Text |
description |
- Product leads
Method: GET
URL: {url}/api/v1/product/leads?all=false
Headers: key:
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
Prams: If parameter all = false it will return only product leads other all leads.
Leads:
For this lead api header will be used.
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- Auth user leads
Method: GET
URL: {url}/api/v1/leads?limit={number}
Headers: Content-Type and Authorization used
Params: key: limit value: number
- Add lead
Method: POST
URL: {url}/api/v1/leads
Headers: Content-Type and Authorization used
Params: Use this params in update lead also
| Body params |
Data type |
Message |
| first_name |
String |
First name |
| last_name |
String |
Last name |
| email |
Number |
Email |
| designation |
string |
Designation |
| notes |
Text |
Description |
| company |
Int |
Select company |
| phone |
Number |
Enter number |
| mobile |
Number |
Enter number |
| picture |
Image |
Upload image |
- Update lead
Method: PUT
URL: {url}/api/v1/leads/{id}
Headers: Content-Type and Authorization used
Params: use same params defined in add lead
- Delete Lead
Method: DELETE
URL: {url}/api/v1/leads/{id}
Headers: Content-Type and Authorization used
- Detail of lead
Method: GET
URL: {url}/api/v1/leads/{id}
Headers: Content-Type and Authorization used
Contacts:
For this contact api header will be used.
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- Auth user contacts
Method: GET
URL: {url}/api/v1/contacts
Headers: Content-Type and Authorization used
- Add contacts
Method: POST
URL: {url}/api/v1/contacts
Headers: Content-Type and Authorization used
Params: use this params for store and update api
| Body params |
Data type |
Message |
| first_name |
String |
First name |
| last_name |
String |
Last name |
| email |
Number |
Email |
| ldsrc_id |
Integer |
Select lead source |
| mobile |
Number |
Enter number |
| picture |
Image |
Upload image |
- Update contacts
Method: PUT
URL: {url}/api/v1/contacts/{id}
Headers: Content-Type and Authorization used
- Delete contacts
Method: DELETE
URL: {url}/api/v1/contacts/{id}
Headers: Content-Type and Authorization used
- Detail of contacts
Method: GET
URL: {url}/api/v1/contacts/{id}
Headers: Content-Type and Authorization used
Deal:
For this deal api header will be used.
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- Auth user deal
Method: GET
URL: {url}/api/v1/deals?limit={number}
Headers: Content-Type and Authorization used
Params: key: limit value: number
- Add deal
Method: POST
URL: {url}/api/v1/deals
Headers: Content-Type and Authorization used
Params: use this params for store and update api
| Body params |
Data type |
Message |
| name |
String |
First name |
| ld_id |
Integer |
Select lead id |
| pro_id |
Integer |
Slect product id |
| sfun_id |
Integer |
Select sales funnel id |
| value |
Number |
Enter value |
| closing_date |
date |
date |
- Update deal
Method: PUT
URL: {url}/api/v1/deals/{id}
Headers: Content-Type and Authorization used
- Delete deal
Method: DELETE
URL: {url}/api/v1/deals/{id}
Headers: Content-Type and Authorization used
- Detail of deal
Method: GET
URL: {url}/api/v1/deals/{id}
Headers: Content-Type and Authorization used
Services:
For this service api header will be used.
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- All Service
Method: GET
URL: {url}/api/v1/api-services?limit={number}&featured={true/false}
Headers: Content-Type header is use for this
Params:
| Key |
Value |
Message |
| limit |
number |
Will list the number of services |
| featured |
true/false |
Will show featured services based on condition (true/false) |
- Add Service
Method: POST
URL: {url}/api/v1/api-services
Headers: Content-Type and Authorization used
Params:
| Body params |
Data type |
Message |
| title |
String |
Service name |
| price |
Value |
Enter price value |
| servcategory_id |
Int |
Select service category |
| serv_subcategory_id |
Int |
Select service sub category |
| company_id |
Int |
Select company id |
| image |
String |
Upload image |
| description |
Text |
Description |
| brand |
String |
Brand name |
| tags |
string |
tags |
- Service Lead Store
Method: POST
URL: {url}/api/v1/api-services/leads
Headers: Content-Type and Authorization used
Params:
| Body params |
Data type |
Message |
| name |
String |
Service name |
| mobile |
number |
Enter number |
| service_id |
Int |
Select service id |
| notes |
Text |
Notes |
- Detail of Services
Method: GET
URL: {url}/api/v1/api-services/{slug}
Headers: Content-Type and Authorization used
- Auth User Services
Method: GET
URL: {url}/api/v1/services?limit={number}
Headers: Content-Type and Authorization used
Params:
| Key |
Value |
Message |
| limit |
number |
Will list the number of services |
Common API’s for Select Values/Id (for dropdown)
| Key |
Value |
Message |
| Content-Type |
application/json |
|
| Authorization |
{auth_token} |
After login the login api gives you to a auth token as well.Get your auth token from login or register api. |
- Get Currencies
Method: GET
URL: {url}/api/v1/currencies
Headers: Content-Type and Authorization used
- Account Type
Method: GET
URL: {url}/api/v1/account-type
Headers: Content-Type and Authorization used
- Industry Type
Method: GET
URL: {url}/api/v1/industry-type
Headers: Content-Type and Authorization used
- Category List
Method: GET
URL: {url}/api/v1/list-category
Headers: Content-Type and Authorization used
- Subcategory List
Method: GET
URL: {url}/api/v1/list-subcategory?limit=10&category_id=1
Headers: Content-Type and Authorization used
Params:
| Key |
Value |
Message |
| limit |
number |
Will list the number of subcategories |
| category_id |
Integer |
For which category do you want the list of subcategories |
- States
Method: GET
URL: {url}/api/v1/states/{country_id}
Headers: Content-Type and Authorization used
- Countries
Method: GET
URL: {url}/api/v1/countries
Headers: Content-Type and Authorization used
- Deal Type
Method: GET
URL: {url}/api/v1/deal-type
Headers: Content-Type and Authorization used
- Lead Type
Method: GET
URL: {url}/api/v1/lead-type
Headers: Content-Type and Authorization used
- Lead Source
Method: GET
URL: {url}/api/v1/lead-source
Headers: Content-Type and Authorization used
- Units
Method: GET
URL: {url}/api/v1/units
Headers: Content-Type and Authorization used
Dashboard Purposes
- Auth User Profile
Method: GET
URL: {url}/api/v1/profile
Headers: Content-Type and Authorization used
- User Company
Method: GET
URL: {url}/api/v1/auth/company
Headers: Content-Type and Authorization used
- User Product
Method: GET
URL: {url}/api/v1/auth/product?limit={number}
Headers: Content-Type and Authorization used
