Smarty CRM API

Introduction

The Smarty CRM API allows you to perform all the operations that you do with our web client.

Smarty CRM API is built using REST principles which ensures predictable URLs that makes writing applications easy. This API follows HTTP rules, enabling a wide range of HTTP clients can be used to interact with the API.

Every resource is exposed as a URL. The URL of each resource can be obtained by accessing the API Root Endpoint.

OAuth

Smarty CRM REST APIs uses the OAuth 2.0 protocol to authorize and authenticate calls. It provides secure access to protect resources thereby reducing the hassle of asking for a username and password everytime a user logs in. Follow the steps listed here, to access CRM’s APIs using OAuth 2.0

API URL : https://apicrm.smartysoftware.net

Step 1: Registering New Client

You will have to first sign up in Smarty CRM and then register your application in order to get your Client ID and Client Secret.

To register your application, Please contact us at support-crm@smartysoftware.net

We will give you OAuth 2.0 credentials such as a Client ID and Client Secret that are known to both Smarty CRM and your application. Do not share this credentials anywhere.

Step 2: Generate Access and Refresh Token

After Client ID and Client Secret from the above step, make a POST request for the following URL with given params, to generate the access_token.

API : https://oauth.smartysoftware.net/authenticate/accesstoken
ParameterDescription
client_idClient ID obtained during Client Registration.
client_secretClient secret obtained during Client Registration.
usernameEmail of user.
passwordPassword of user.

POST

Request Example

$ curl https://oauth.smartysoftware.net/authenticate/accesstoken
-X POST
-H "Content-Type: application/json"
			

In the response, you will get both access_token and refresh_token.

1. The access_token will expire after a particular period (as given in expires_in param in the response).

2. The refresh_token is permanent and will be used to regenerate new access_token, if the current access token is expired.

Step 3: Generate Access Token From Refresh Token

Access Tokens have limited validity. In most general cases the access tokens expire in one hour. Until then, the access token has unlimited usage. Once it expires, your app will have to use the refresh token to request for a new access token. Redirect to the following POST URL with the given params to get a new access token

API : https://oauth.smartysoftware.net/authenticate/refreshtoken
ParameterDescription
client_idClient ID obtained during Client Registration.
client_secretClient secret obtained during Client Registration.
refresh_tokenrefresh token which is obtained in the above step

POST

Request Example

$ curl https://oauth.smartysoftware.net/authenticate/refreshtoken
-X POST
-H "Content-Type: application/json"
			

Step 4: Calling An API

Access Token can be passed only in header and cannot be passed in the request param.

Header name should be Authorization: {access_token}

HTTP Methods

Smarty CRM API uses appropriate HTTP verbs for every action.

MethodDescription
GETUsed for retrieving resources.
POSTUsed for creating resources and performing resource actions.
PUTUsed for updating resources.
DELETEUsed for deleting resources.
Response

Responses will be in the JSON format.

Node NameDescription
statusThe status of request. This will be success for a success response and error in case of an error.
messageMessage for the invoked API.
resource nameComprises the invoked API’s Data.
Errors

Smarty CRM uses HTTP status codes to indicate success or failure of an API call. In general, status codes in the 2xx range means success, 4xx range means there was an error in the provided information, and those in the 5xx range indicate server side errors. Commonly used HTTP status codes are listed below.

HTTP Status Codes

Status CodeDescriptions
2xxSuccess
4xxBad request sent to server
5xxServer side error
Status CodeDescription
200SuccessThe request was successfully completed.
201CreatedThe request was a success and one or more resources have been created.
400Bad requestThe request cannot be performed. Usually because of malformed parameter or missing parameter.
401Unauthorized (Invalid AuthToken)Request was rejected because of invalid AuthToken.
403ForbiddenThe user does not have enough permission or possibly not an user of the respective organization to access the resource.
404URL Not FoundThe URL you’ve sent is wrong. It’s possible that the resource you’ve requested has been moved to another URL.
405Method Not AllowedThe requested resource does not support the HTTP method used. For example, requesting List of all customers API with PUT as the HTTP method.
406Not AcceptableThe requested response type is not supported by the client.
429Too many requestsToo many requests within a certain time frame.
500Server errorSmarty CRM server encountered an error which prevents it from fulfilling the request. Although this rarely happens, we recommend you to contact us at support-crm@smartysoftware.net if you receive this error.
Pagination

Most of the lists/item collections are paginated. The parameters that control the pagination are start and length, indicating the desired offset and the items per page values.

Currency list

Get list of currency.

GET /currency

Request Example

$ curl https://setting.smartysoftware.net/utility/currency
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
    {
        "id": 1,
        "currency": "Afghanistan Afghani (AFN)",
        "key": "AFN"
    },
    {
        "id": 2,
        "currency": "Albanian Lek (ALL)",
        "key": "ALL"
    },
	.
	.
	.
]		   
Timezone list

Get list of timezones.

GET /timezone

Request Example

$ curl https://setting.smartysoftware.net/utility/timezone
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
    {
        "id": 1,
        "value": "Pacific/Niue",
        "view": "(GMT-11:00) Niue",
        "difference": "-11:00"
    },
    {
        "id": 2,
        "value": "Pacific/Pago_Pago",
        "view": "(GMT-11:00) Pago Pago",
        "difference": "-11:00"
    },
	.
	.
	.
]		   
Industry list

Get list of industries.

GET /industry

Request Example

$ curl https://setting.smartysoftware.net/utility/industry
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
    [
    "Marketing, PR and Advertising",
    "Manufacturing and Industrial",
    "Procurement",
    "Public Sector",
	.
	.
	.
]		   
Locale list

Get list of locale.

GET /locale

Request Example

$ curl https://setting.smartysoftware.net/utility/locale
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
				{
					"id": 2,
					"local": "aa_ER",
					"lable": "Afar (Eritrea)",
					"date_format": "MMMM d, y",
					"time_format": "'at' h:mm a",
					"date_time_format": "MMMM d, y 'at' h:mm a"
				},
				{
					"id": 3,
					"local": "aa_ET",
					"lable": "Afar (Ethiopia)",
					"date_format": "MMMM d, y",
					"time_format": "'at' h:mm a",
					"date_time_format": "MMMM d, y 'at' h:mm a"
				},
				.
				.
				.
			]		   
Security questions

Get list of sequrity questions.

GET /forgetpass

Request Example

$ curl https://oauth.smartysoftware.net/forgetpass/securityquestion
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
				"What Is your favorite book?",
				"What is the name of the road you grew up on?",
				"What is your mother’s maiden name?",
				"What was the name of your first/current/favorite pet?",
				"What was the first company that you worked for?",
				"Where did you meet your spouse?",
				.
				.
				.
			]		   
Pipeline list

Get list of pipelines.

ARGUMENTS

action

Required - String

owner_company

Required - String

POST /setting

Request Example

$ curl https://apicrm.smartysoftware.net/setting/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "pipeLine"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
				{
					"id": 1,
					"name": "Sales - Leads",
					"type": "default",
					"show_probability": 0,
					"stage_count": 6
				},
				{
					"id": 2,
					"name": "John - Leads",
					"type": "public",
					"show_probability": 1,
					"stage_count": 8
				},
				.
				.
				.
			] 		
 				   
Stage list

Get list of pipeline stages.

ARGUMENTS

action

Required - String

id_pipeline

Required - Integer

owner_company

Required - String

POST /setting

Request Example

$ curl https://apicrm.smartysoftware.net/setting/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "stage"
			"id_pipeline": "{id_pipeline}"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
				{
					"id": 1,
					"pipeline_id": 1,
					"name": "Lead In",
					"probability": 100
				},
				{
					"id": 3,
					"pipeline_id": 1,
					"name": "Prospect Qualified",
					"probability": 100
				},
				.
				.
				.
			] 		
 				   
Info

Get user details.

ARGUMENTS

action

Required - String

POST /user

Request Example

$ curl https://oauth.smartysoftware.net/user/info
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "identify"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
			"id": 245,
    "identify": "D_0001",
    "first_name": "Demo",
    "last_name": "User",
    "email": "hello@smartysoftware.net",
    "signup_source": "Acc-Software",
    "phone": "20 3637 4716",
    "phone_code": "+44",
    "address1": "68 King William St",
    "address2": null,
    "country": "England",
    "city": "London",
    "state": null,
    "zip_code": "EC4N 7DZ",
    "birthday": null,
    "gender": "male",
    "questions": "a:3:{s:27:"What Is your favorite book?";s:21:"The Lord of the Rings";s:41:"Where is your favorite place to vacation?";s:5:"Ibiza";s:27:"What is your favorite food?";s:12:"Qormeh Sabzi";}",
    "2factorsecret": null,
    "locale": "en_GB",
    "currency": "GBP",
    "last_login": "2020-06-22 10:39:39",
    "updated_at": "2020-06-22 10:39:39",
    "cdate": "2018-12-16 12:09:50",
    "notification_setting": "{"task": {"assign": "on"}, "email": {"open": "on", "click": "on", "receive": "on"}, "income": {"busy": "on", "complete": "on", "noAnswer": "on"}, "webform": {"submit": "on"}}",
    "reminder_setting": "{"mode": {"time": "same"}, "type": ["all"]}"
 		},
 		
 				   
Info by company

Get user details in company.

ARGUMENTS

action

Required - String

id_company

Required - String

To access organisations related APIs

POST /user

Request Example

$ curl https://oauth.smartysoftware.net/user/info
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "identify&company"
			"id_company": "{id_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
			"id": 305,
    "identify": "D_0001",
    "first_name": "Demo",
    "last_name": "User",
    "email": "hello@smartysoftware.net",
    "signup_source": "Acc-Software",
    "phone": "20 3637 4716",
    "phone_code": "+44",
    "address1": "68 King William St",
    "address2": null,
    "country": "England",
    "city": "London",
    "state": null,
    "zip_code": "EC4N 7DZ",
    "birthday": null,
    "gender": "male",
    "questions": "a:3:{s:27:"What Is your favorite book?";s:21:"The Lord of the Rings";s:41:"Where is your favorite place to vacation?";s:5:"Ibiza";s:27:"What is your favorite food?";s:12:"Qormeh Sabzi";}",
    "2factorsecret": null,
    "locale": "en_GB",
    "currency": "GBP",
    "last_login": "2020-06-22 10:51:13",
    "updated_at": "2019-08-08 15:34:15",
    "cdate": "2018-12-16 12:25:30",
    "notification_setting": "{"task": {"assign": "on"}, "email": {"open": "on", "click": "on", "receive": "on"}, "income": {"busy": "on", "complete": "on", "noAnswer": "on"}, "webform": {"submit": "on"}}",
    "reminder_setting": "{"mode": {"time": "same"}, "type": ["all"]}",
    "id_company": 272,
    "expire_time": 18000,
    "can_assign_to": null,
    "company_name": "Smarty Software Demo",
    "user_identify": "D_0001",
    "user_type": "SuperAdmin",
    "status": "Active",
    "maker_identify": "D_0001",
    "table_visibility": "{"deal": "myself", "person": "myself", "company": "myself", "activity": "myself"}",
    "resources": null,
    "rand_email": "smartysoftwareltd",
    "timezone": "Europe/London",
    "id_plans": "FBI84mW6",
    "users_count": 1,
    "payment_status": "Lifetime",
    "due_date": "2020-08-28 00:00:00",
    "first_setup": "success",
    "integrate_details": "{"email": "hello@smartysoftware.net", "api_key": "5df686b8262d11eabf27a4bf012390ab", "id_user": "D_0001", "sync_mode": "never"}",
    "integrate_with_accounting": "Yes",
    "planname": "ScaleUp"
 		}
 		
 				   
Company list

Get list of user company.

ARGUMENTS

action

Required - String

POST /user

Request Example

$ curl https://oauth.smartysoftware.net/user/company
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "list"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[{
        "id": 272,
        "user_type": "SuperAdmin",
        "cdate": "2018-12-16 12:25:30",
        "id_plans": "FBI84mW6",
        "company_name": "Smarty Software Demo",
        "users_count": 1,
        "name": "ScaleUp",
        "payment_status": "Lifetime",
        "due_date": "2020-08-28 00:00:00",
        "industry": "Software Provider",
        "timezone": "Europe/London"
    },
    .
	.
	.
	]
 		
 				   
User

Get list of company users.

ARGUMENTS

action

Required - String

id_company

Required - String

POST /user

Request Example

$ curl https://oauth.smartysoftware.net/user/company
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "child"
			"id_company": "{id_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[{
        "identify": "S_0290",
        "name": "Sherlock Holmes"
    },
    {
        "identify": "J_0291",
        "name": "John Watson"
    },
    {
        "identify": "W_0292",
        "name": "James Moriarty"
    },
    .
	.
	.
	]
 		
 				   
Add company

Add new company to contacts.

ARGUMENTS

action

Required - String

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

visible_to

Required - String

one of the "Entire company" or "Owner followers"

address

Optional - String

POST /company

Request Example

$ curl https://apicrm.smartysoftware.net/company/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "add"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"name": "Smarty software ltd"
			"address": "['address'=>'Silverthorne Road, London SW8 3HE, UK',
						 'street_number'=>'',
						 'route'=>'Silverthorne Road',
						 'locality'=>'',
						 'country'=>'United Kingdom',
						 'administrative_area_level_1'=>'England',
						 'postal_code'=>'SW8 3HE']"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Company added successfully.",
				"id": 556
			}		   
Edit company

Edit contact company.

ARGUMENTS

action

Required - String

id

Required - String

id of edit company

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

visible_to

Required - String

one of the "Entire company" or "Owner followers"

address

Optional - String

POST /company

Request Example

$ curl https://apicrm.smartysoftware.net/company/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "edit"
			"id": "[{id_company}]"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"name": "Smarty software ltd"
			"address": "['address'=>'Silverthorne Road, London SW8 3HE, UK',
						 'street_number'=>'',
						 'route'=>'Silverthorne Road',
						 'locality'=>'',
						 'country'=>'United Kingdom',
						 'administrative_area_level_1'=>'England',
						 'postal_code'=>'SW8 3HE']"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Company edited successfully."
			}		   
Delete company

Delete contact company.

ARGUMENTS

action

Required - String

id

Required - String

id of edit company

owner_company

Required - String

POST /company

Request Example

$ curl https://apicrm.smartysoftware.net/company/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "delete"
			"id": "[{id_company}]"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "1 company deleted successfully."
			}		   
Suggest company

Suggest company by name.

ARGUMENTS

action

Required - String

owner_company

Required - String

query

Required - String

part of company name

GET /company

Request Example

$ curl https://apicrm.smartysoftware.net/company/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "suggest"
			"owner_company": "{owner_company}"
			"query": {company_name}
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


	
	[
				{
        "id": 464,
        "name": "Smarty Software",
        "address": null
    },
    {
        "id": 466,
        "name": "Smarty Software",
        "address": null
    },
	.
	.
	.
	]
	
 		
 				   
Company list

Get list of company.

ARGUMENTS

action

Required - String

owner_company

Required - String

id_user

Required - String

start

Required - Integer

length

Required - Integer

GET /company

Request Example

$ curl https://apicrm.smartysoftware.net/company/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "list"
			"owner_company": "{owner_company}"
			"id_user": "{id_user}"
			"start": 0
			"length": 10
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"draw": 1,
			"recordsTotal": 225,
			"recordsFiltered": 225,
			data:[
						{
					"company_name": "B&F Services",
					"company_d6abf19a-1fc8-11e9-98af-a4bf012390aa": "Consultancy",
					"company_address": "{"address":"68 King William St, London EC4N 7DZ, UK","street_number":"68","route":"King William Street","locality":"","administrative_area_level_1":"England","country":"United Kingdom","postal_code":"EC4N 7HR"}",
					"company_people_count": 1,
					"company_owner_id": "D_0001",
					"company_2d75c1f8-0134-11e9-b876-a4bf012390aa": "www.bfsc.co.uk",
					"company_activities_count": 1,
					"company_created_at": "2019-05-05 05:09:03",
					"company_a1d229dc-4045-11ea-a86b-a4bf012390aa": null,
					"company_id": 465
				},
				{
					"company_name": "Smarty Software",
					"company_d6abf19a-1fc8-11e9-98af-a4bf012390aa": "Software",
					"company_address": "{"address":"68 King William St, London EC4N 7DZ","street_number":"","route":"","locality":"","administrative_area_level_1":"","country":"","postal_code":""}",
					"company_people_count": 1,
					"company_owner_id": "D_0001",
					"company_2d75c1f8-0134-11e9-b876-a4bf012390aa": "www.smartysoftware.net",
					"company_activities_count": 9,
					"company_created_at": "2019-05-04 12:11:21",
					"company_a1d229dc-4045-11ea-a86b-a4bf012390aa": null,
					"company_id": 464
				},
			.
			.
			.
			]
	
 		
 				   
Company details

Get details of contact company.

ARGUMENTS

action

Required - String

owner_company

Required - String

id

Required - String

POST /company

Request Example

$ curl https://apicrm.smartysoftware.net/company/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "details"
			"id": "{id_company}"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"id": 542,
				"name": "Sarrail Lynch & Hall",
				"owner_id": "D_0001",
				"people_count": 1,
				"open_deals_count": 1,
				"followers_id": null,
				"visible_to": "Entire company",
				"next_activity_date": null,
				"last_activity_date": null,
				"won_deals_count": 0,
				"lost_deals_count": 0,
				"closed_deals_count": 0,
				"activities_count": 0,
				"done_activities_count": 0,
				"undone_activities_count": 0,
				"email_messages_count": 0,
				"address": "{"address":"464 Back Nile St #618, Greater London, W3 6QJ","street_number":"","route":"464 Back Nile St #618","locality":"","administrative_area_level_1":"Greater London","country":"","postal_code":"W3 6QJ"}",
				"people_id": null,
				"call_count": 0,
				"pic_url": null,
				"dna": null,
				"source": null,
				"relation": null,
				"existence": "Exist",
				"demo": 0,
				"created_at": "2020-01-26 18:06:11",
				"updated_at": null,
				"2d75c1f8-0134-11e9-b876-a4bf012390aa": "http://www.sarraillynchhall.co.uk",
				"d6abf19a-1fc8-11e9-98af-a4bf012390aa": null,
				"5dc11fea-636f-11e9-ac23-a4bf012390aa": null,
				"a1d229dc-4045-11ea-a86b-a4bf012390aa": "[{"phone":"01862-338494","code":"","type":"Work","unique_phone":"01862-338494"}]"
			}		   
Add person

Add new person to contacts.

ARGUMENTS

action

Required - String

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

visible_to

Required - String

one of the "Entire company" or "Owner followers"

name

Required - String

phone

Optional - Array

email

Optional - Array

company

Optional - String

company_id

Optional - Integer

POST /person

Request Example

$ curl https://apicrm.smartysoftware.net/person/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "add"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"name": "Sherlock Holmes"
			"phone": "['phone'=>['01507-386397','01876-642683'],'code'=>['',''],'type'=>['Home','Work']]"
			"email": "['email'=>['erasmo_rhea@hotmail.com','ahmad.alsaqri@yahoo.com'],'type'=>['Home','Work']]"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Person added successfully.",
				"id": 924
			}		   
Edit person

Edit person info.

ARGUMENTS

action

Required - String

id

Required - Array

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

visible_to

Required - String

one of the "Entire company" or "Owner followers"

name

Required - String

phone

Optional - Array

email

Optional - Array

company

Optional - String

company_id

Optional - Integer

POST /person

Request Example

$ curl https://apicrm.smartysoftware.net/person/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "edit"
			"id": "[{id_person}]"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"name": "Sherlock Holmes"
			"phone": "['phone'=>['01507-386397','01876-642683'],'code'=>['',''],'type'=>['Home','Work']]"
			"email": "['email'=>['erasmo_rhea@hotmail.com','ahmad.alsaqri@yahoo.com'],'type'=>['Home','Work']]"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Person edited successfully."
			}		   
Delete person

Delete person info.

ARGUMENTS

action

Required - String

id

Required - Array

owner_company

Required - String

POST /person

Request Example

$ curl https://apicrm.smartysoftware.net/person/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "delete"
			"id": "[{id_person}]"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "1 person deleted successfully."
			}		   
Suggest person

Suggest company by name.

ARGUMENTS

action

Required - String

owner_company

Required - String

query

Required - String

part of person name

mood

Required - String

GET /person

Request Example

$ curl https://apicrm.smartysoftware.net/person/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "suggest"
			"owner_company": "{owner_company}"
			"query": {company_name}
			"mood": "name"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
			{
				"id": 232,
				"company_id": 236,
				"name": "Louie Rees",
				"company": "Herman's World of Sporting Goods",
				"email": "["LouieRees@dayrep.com"]",
				"phone": "["077 6651 6961"]"
			},
			{
				"id": 251,
				"company_id": 255,
				"name": "Micah Jensen",
				"company": "Ipsum Non Industries",
				"email": "["at.fringilla.purus@magnaUttincidunt.co.uk"]",
				"phone": "["07592 752122"]"
			},
			.
			.
			.
		]
	
 		
 				   
Person list

Get list of person.

ARGUMENTS

action

Required - String

owner_company

Required - String

id_user

Required - String

start

Required - Integer

length

Required - Integer

GET /person

Request Example

$ curl https://apicrm.smartysoftware.net/person/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "list"
			"owner_company": "{owner_company}"
			"id_user": "{id_user}"
			"start": 0
			"length": 10
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"draw": 1,
			"recordsTotal": 225,
			"recordsFiltered": 225,
			data:[
				{
					"person_name": "Misha",
					"person_company": "B&F Services",
					"person_email": "[{"email":"misha@bfsc.co.uk","type":"Work"}]",
					"person_phone": "[{"phone":"+447480802184","code":"","type":"Work","unique_phone":"+447480802184"}]",
					"person_created_at": "2019-05-05 05:09:04",
					"company_address": "{"address":"68 King William St, London EC4N 7DZ, UK","street_number":"68","route":"King William Street","locality":"","administrative_area_level_1":"England","country":"United Kingdom","postal_code":"EC4N 7HR"}",
					"person_id": 814,
					"person_company_id": 465
				},
				{
					"person_name": "Ivy Rivers",
					"person_company": "Eget Inc.",
					"person_email": "[{"email":"molestie@auctor.com","type":"Work"}]",
					"person_phone": "[{"phone":"03593 250084","code":"","type":"Work","unique_phone":"03593250084"}]",
					"person_created_at": "2019-01-24 06:51:42",
					"company_address": "{"address":"622-1819 Amet Ave","street_number":"","route":"","locality":"","administrative_area_level_1":"","country":"","postal_code":""}",
					"person_id": 332,
					"person_company_id": 336
				},
				.
				.
				.
			] 		
 				   
Person details

Get details of contact person.

ARGUMENTS

action

Required - String

owner_company

Required - String

id

Required - String

GET /person

Request Example

$ curl https://apicrm.smartysoftware.net/person/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "details"
			"id": "{id_person}"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"id": 232,
				"name": "Louie Rees",
				"phone": "[{"phone":"077 6651 6961","code":"","type":"Work","unique_phone":"07766516961"}]",
				"email": "[{"email":"LouieRees@dayrep.com","type":"Work"}]",
				"company_id": 236,
				"company": "Herman's World of Sporting Goods",
				"owner_id": "D_0001",
				"open_deals_count": 0,
				"followers_id": null,
				"visible_to": "Entire company",
				"next_activity_date": null,
				"last_activity_date": null,
				"won_deals_count": 0,
				"lost_deals_count": 0,
				"closed_deals_count": 0,
				"activities_count": 0,
				"done_activities_count": 0,
				"undone_activities_count": 0,
				"email_messages_count": 0,
				"last_incoming_mail_time": null,
				"last_outgoing_mail_time": null,
				"call_count": 0,
				"last_incoming_call_time": null,
				"last_outgoing_call_time": null,
				"pic_url": null,
				"dna": null,
				"source": null,
				"related_customer_id": 0,
				"existence": "Exist",
				"demo": 0,
				"created_at": "2019-01-23 07:57:56",
				"updated_at": null,
				"e3aab62e-342c-11e9-9143-a4bf012390aa": null,
				"0160b214-5abf-11e9-946f-a4bf012390aa": null,
				"4a5cb5ae-64d2-11e9-940e-a4bf012390aa": null,
				"4738006e-9fd2-11e9-969f-a4bf012390aa": null
			}		   
Add

Add new sales opportunity.

ARGUMENTS

action

Required - String

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

pipeline_id

Required - Integer

stage_id

Required - Integer

title

Required - String

value

Optional - Array

visible_to

Required - String

one of the "Entire company" or "Owner followers"

expected_close_date

Optional - Date

probability

Optional - Integer

person

Optional - String

person_id

Optional - Ineteger

company

Optional - String

company_id

Optional - Integer

POST /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "add"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"title": "David Edwards sales opportunity"
			"value": "['value'=>'500','currency'=>'GBP']"
			"visible_to": "Entire company"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Deal added successfully.",
				"id": 386
			}		   
Edit

Edit sales opportunity.

ARGUMENTS

action

Required - String

id

Required - Array

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

pipeline_id

Required - Integer

stage_id

Required - Integer

title

Required - String

value

Optional - Array

visible_to

Required - String

one of the "Entire company" or "Owner followers"

expected_close_date

Optional - Date

probability

Optional - Integer

person

Optional - String

person_id

Optional - Ineteger

company

Optional - String

company_id

Optional - Integer

POST /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "edit"
			"id": "[id_deal]"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"title": "David Edwards sales opportunity"
			"value": "['value'=>'500','currency'=>'GBP']"
			"visible_to": "Entire company"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Deal edited successfully."
			}		   
Delete

Delete sales opportunity.

ARGUMENTS

action

Required - String

id

Required - Array

owner_company

Required - String

POST /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "delete"
			"id": "[id_deal]"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "1 deal deleted successfully."
			}		   
List

Get list of sales opportunity.

ARGUMENTS

action

Required - String

owner_company

Required - String

id_user

Required - String

start

Required - Integer

length

Required - Integer

GET /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "list"
			"owner_company": "{owner_company}"
			"id_user": "{id_user}"
			"start": 0
			"length": 10
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"draw": 1,
			"recordsTotal": 225,
			"recordsFiltered": 225,
			data:[
				{
					"deal_title": "Ivy Rivers sales opportunity",
					"deal_value": "{"value":"5000.00","currency":"GBP"}",
					"deal_company": "Sit Company",
					"deal_person": "Ivy Rivers",
					"deal_stage": "Lead In",
					"deal_pipeline": "Sales - Leads",
					"deal_status": "Open",
					"deal_owner_id": "D_0001",
					"deal_id": 299,
					"deal_person_id": 332,
					"deal_company_id": 325,
					"undone_activities_count": -2,
					"currency": "GBP"
				},
				{
					"deal_title": "David Edwards sales opportunity",
					"deal_value": "{"value":"5500.00","currency":"GBP"}",
					"deal_company": "B&F Services",
					"deal_person": "David Edwards",
					"deal_stage": "Prospect Qualified",
					"deal_pipeline": "Sales - Leads",
					"deal_status": "Open",
					"deal_owner_id": "D_0001",
					"deal_id": 246,
					"deal_person_id": 775,
					"deal_company_id": 448,
					"undone_activities_count": -2,
					"currency": "GBP"
				},
				.
				.
				.
			] 		
 				   
Suggest

Suggest company by name.

ARGUMENTS

action

Required - String

owner_company

Required - String

query

Required - String

part of person name

GET /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "suggest"
			"owner_company": "{owner_company}"
			"query": {company_name}
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
			{
				"id": 23,
				"company_id": 207,
				"person_id": 203,
				"stage": "Prospect Qualified",
				"title": "Evans sales opportunity",
				"company": "Evans",
				"person": "Ryan Fowler"
			},
			{
				"id": 27,
				"company_id": 211,
				"person_id": 207,
				"stage": "Proposal Made",
				"title": "Monsters Inc sales opportunity",
				"company": "Monsters Inc",
				"person": "Harrison Gilbert"
			},
			.
			.
			.
		]
	
 		
 				   
Pipeline

Get list of sales opportunity by pipeline.

ARGUMENTS

action

Required - String

owner_company

Required - String

id_user

Required - String

id_pipeline

Required - Integer

currency

Required - String

GET /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "stageList"
			"owner_company": "{owner_company}"
			"id_pipeline": "{owner_company}"
			"currency": "{company_currency}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"status": "success",
			"deals":[
				{
					"id": 353,
					"pipeline_id": 3,
					"stage_id": 15,
					"activities_count": 0,
					"undone_activities_count": 0,
					"owner_id": "S_0290",
					"status": "Open",
					"created_at": "2020-01-26 18:06:01",
					"closed_time": null,
					"last_activity_date": null,
					"updated_at": "2020-01-26 18:13:08",
					"expected_close_date": null,
					"title": "Paralegal Personnel sales opportunity",
					"value": "12000",
					"currency": "GBP",
					"company": "Paralegal Personnel",
					"person": "Frankie Marruffo"
				},
				{
					"id": 354,
					"pipeline_id": 3,
					"stage_id": 16,
					"activities_count": 0,
					"undone_activities_count": 0,
					"owner_id": "S_0290",
					"status": "Open",
					"created_at": "2020-01-26 18:06:04",
					"closed_time": null,
					"last_activity_date": null,
					"updated_at": "2020-01-26 18:13:14",
					"expected_close_date": null,
					"title": "Sunderland Publishing Co sales opportunity",
					"value": "15000",
					"currency": "GBP",
					"company": "Sunderland Publishing Co",
					"person": "Paola Dease"
				},
				.
				.
				.
			] 		
 				   
Details

Get details of sales opportunity.

ARGUMENTS

action

Required - String

owner_company

Required - String

id

Required - String

GET /deal

Request Example

$ curl https://apicrm.smartysoftware.net/deal/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "details"
			"id": "{id_deal}"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"id": 316,
				"title": "Tiburon Pen Chmbr Commrce Inc sales opportunity",
				"owner_id": "D_0001",
				"value": "{"value":"15000","currency":"GBP"}",
				"company_id": 501,
				"company": "Tiburon Pen Chmbr Commrce Inc",
				"person_id": 862,
				"person": "Graham Stanwick",
				"pipeline_id": 7,
				"pipeline": "Demo - Generated Leads",
				"stage_id": 39,
				"stage": "Approach",
				"stage_change_date": "2020-01-26 00:00:00",
				"next_activity_date": "2020-08-17 11:00:00",
				"last_activity_date": null,
				"won_time": null,
				"last_incoming_mail_time": null,
				"last_outgoing_mail_time": null,
				"lost_time": null,
				"status": "Open",
				"lost_reason": null,
				"lost_comment": null,
				"closed_time": null,
				"invoice_id": null,
				"followers_id": null,
				"participants": null,
				"visible_to": "Entire company",
				"activities_count": 1,
				"done_activities_count": 0,
				"undone_activities_count": 1,
				"email_messages_count": 0,
				"expected_close_date": null,
				"call_count": 0,
				"probability": 0,
				"product_id": 0,
				"product_name": null,
				"existence": "Exist",
				"source": null,
				"demo": 0,
				"created_at": "2020-01-26 17:25:27",
				"updated_at": "2020-01-26 18:30:29",
				"related_email": null
			}		   
History task

Get list of sales opportunity tasks history.

ARGUMENTS

action

Required - String

id

Required - Integer

owner_company

Required - String

mood

Required - String

GET /profile

Request Example

$ curl https://apicrm.smartysoftware.net/profile/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "historyList"
			"owner_company": "{owner_company}"
			"id": "{id_deal}"
			"mode": "deal"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"recordsTotal": 2,
			"recordsFiltered": 2,
			"data":[
				{
					"owner": "D_0001",
					"type": "changelog",
					"desc": "Stage: Prospecting&nbsp;<i class="icon-arrow-right8 text-muted" style="font-size:12px"></i>&nbsp;Approach",
					"created_at": "2020-01-26 17:26:08",
					"updated_at": null,
					"email_attachment": null,
					"deal_title": "Tiburon Pen Chmbr Commrce Inc sales opportunity",
					"person_name": null,
					"company_name": null,
					"id_note": 0,
					"note_desc": null,
					"note_is_pin": "No",
					"id_file": 0,
					"file_name": null,
					"file_desc": null,
					"file_size": 0,
					"id_activity": 0,
					"activity_title": null,
					"activity_desc": null,
					"activity_duedate": null,
					"activity_duetime": null,
					"activity_all_day": 0,
					"activity_status": "Incomp",
					"activity_icon": "Incomp",
					"id_call": 0,
					"call_status": null,
					"call_price": 0,
					"call_duration": 0,
					"call_desc": null,
					"call_mode": "Outgoing",
					"call_country": null,
					"call_from": null,
					"call_to": null,
					"call_record": null,
					"id_email": 0,
					"email_body": null,
					"email_html_body": null,
					"email_mode": "Receive",
					"email_is_open": "no",
					"email_is_click": "no",
					"email_subject": null,
					"email_from": null,
					"email_to": null,
					"email_cc": null,
					"email_bcc": null
				},
				.
				.
				.
			]
 				   
Upcoming task

Get list of sales opportunity upcoming tasks.

ARGUMENTS

action

Required - String

id

Required - Integer

owner_company

Required - String

mood

Required - String

GET /profile

Request Example

$ curl https://apicrm.smartysoftware.net/profile/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "upcomingTask"
			"owner_company": "{owner_company}"
			"id": "{id_deal}"
			"mode": "deal"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"recordsTotal": 1,
			"recordsFiltered": 1,
			"data":[
				{
					"owner": "D_0001",
					"created_at": "2020-01-26 18:30:29",
					"updated_at": null,
					"deal_title": "Tiburon Pen Chmbr Commrce Inc sales opportunity",
					"person_name": "Graham Stanwick",
					"company_name": "Tiburon Pen Chmbr Commrce Inc",
					"id_activity": 269,
					"activity_title": "Lunch",
					"activity_desc": "<p>&nbsp;</p>",
					"activity_duedate": "2020-08-17",
					"activity_duetime": "11:00:00",
					"activity_all_day": 0,
					"activity_status": "Incomp",
					"activity_icon": "icon-coffee"
				}
			],
			"counter":[
				"changelog": 2
			]
 				   
Add

Add new activity.

ARGUMENTS

action

Required - String

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

name

Required - String

id_type

Required - Integer

due_date

Required - Date

due_time

Optional - Time

duration

Optional - Integer

must be in seconds

note

Optional - String

assign_to

Required - String

deal_title

Optional - String

deal_id

Optional - Integer

company_name

Optional - String

company_id

Optional - Integer

send_invite

Optional - Boolean

timezone

Required - String

persons_id

Optional - String

POST /activity

Request Example

$ curl https://apicrm.smartysoftware.net/activity/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "add"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"name": "{activity_name}"
			"id_type": "{id_type}"
			"due_date": "{due_date}"
			"assign_to": "{id_user}"
			"timezone": "Europe/London"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Activity added successfully.",
				"id": 390
			}		   
Edit

Edit activity.

ARGUMENTS

action

Required - String

id

Required - Array

owner_id

Required - String

id of user who add the contact

owner_company

Required - String

name

Required - String

id_type

Required - Integer

due_date

Required - Date

due_time

Optional - Time

duration

Optional - Integer

must be in seconds

note

Optional - String

assign_to

Required - String

deal_title

Optional - String

deal_id

Optional - Integer

company_name

Optional - String

company_id

Optional - Integer

send_invite

Optional - Boolean

timezone

Required - String

persons_id

Optional - String

POST /activity

Request Example

$ curl https://apicrm.smartysoftware.net/activity/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "edit"
			"id": "[{id_activity}]"
			"owner_company": "{owner_company}"
			"owner_id": "{id_user}"
			"name": "{activity_name}"
			"id_type": "{id_type}"
			"due_date": "{due_date}"
			"assign_to": "{id_user}"
			"timezone": "Europe/London"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Activity edited successfully."
			}		   
Done or Todo

Change activity status.

ARGUMENTS

action

Required - String

id

Required - Array

complete_by

Required - String

id of user who add the contact

owner_company

Required - String

status

Required - String

Comp or Incomp

timezone

Required - String

POST /activity

Request Example

$ curl https://apicrm.smartysoftware.net/activity/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "edit"
			"id": "[{id_activity}]"
			"owner_company": "{owner_company}"
			"complete_by": "{id_user}"
			"status": "{status}"
			"timezone": "Europe/London"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Activity edited successfully."
			}		   
Delete

Delete activity.

ARGUMENTS

action

Required - String

id

Required - Array

owner_company

Required - String

timezone

Required - String

POST /activity

Request Example

$ curl https://apicrm.smartysoftware.net/activity/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "remove"
			"id": "[{id_activity}]"
			"owner_company": "{owner_company}"
			"timezone": "Europe/London"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"message": "Activity deleted successfully."
			}		   
Type

Get list of activity type.

ARGUMENTS

action

Required - String

owner_company

Required - String

POST /setting

Request Example

$ curl https://apicrm.smartysoftware.net/setting/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "activityType"
			"owner_company": "{owner_company}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

[
				{
					"id": 1,
					"name": "Call",
					"icon": "icon-phone2",
					"order": 1,
					"status": "Active"
				},
				{
					"id": 5,
					"name": "Email",
					"icon": "icon-paperplane",
					"order": 2,
					"status": "Active"
				},
				.
				.
				.
			] 		
 				   
List

Get list of activities.

ARGUMENTS

action

Required - String

owner_company

Required - String

id_user

Required - String

start

Required - Integer

length

Required - Integer

GET /activity

Request Example

$ curl https://apicrm.smartysoftware.net/activity/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "list"
			"owner_company": "{owner_company}"
			"id_user": "{id_user}"
			"start": 0
			"length": 10
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			"draw": 1,
			"recordsTotal": 225,
			"recordsFiltered": 225,
			data:[
				{
					"activities_status": "Incomp",
					"activities_name": "New Sales Opportunity Meeting",
					"activities_deal_title": "sherl",
					"activities_due_date": "2020-06-30",
					"activities_duration": 0,
					"activities_assign_to": "D_0001",
					"activities_person_name": null,
					"person_email": null,
					"person_phone": null,
					"activities_company_name": null,
					"activities_id_type": 2,
					"activities_completed_at": null,
					"activities_updated_at": "2020-06-23 11:11:18",
					"activities_id": 389,
					"activities_due_time": "00:00:01",
					"activities_company_id": 0,
					"activities_deal_id": 386,
					"activities_persons_id": null,
					"activities_icon": "icon-users4",
					"activities_type_name": "Meeting",
					"activities_all_day": 1
				},
				.
				.
				.
			] 		
 				   
Details

Get details of activity.

ARGUMENTS

action

Required - String

owner_company

Required - String

id

Required - String

timezone

Required - String

GET /activity

Request Example

$ curl https://apicrm.smartysoftware.net/activity/
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "details"
			"id": "{id_activity}"
			"owner_company": "{owner_company}"
			"timezone": "{company_timezone}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"activities_id": 390,
				"activities_name": "test",
				"activities_id_event": "47250f42b5dc11eaa4f8a4bf012390aa",
				"activities_owner_id": "D_0001",
				"activities_assign_to": "D_0001",
				"activities_due_date": "2020-06-25",
				"activities_due_time": "00:00:01",
				"activities_duration": "00:00:00",
				"activities_all_day": 1,
				"activities_id_type": 3,
				"activities_icon": "icon-watch2",
				"activities_type_name": "Task",
				"activities_company_id": 0,
				"activities_company_name": null,
				"activities_deal_id": 0,
				"activities_deal_title": null,
				"activities_persons_id": null,
				"activities_person_name": null,
				"activities_note": null,
				"activities_last_notification": null,
				"activities_status": "Comp",
				"activities_completed_at": null,
				"activities_complete_by": "D_0001",
				"activities_existence": "Remove",
				"activities_demo": 0,
				"activities_created_at": "2020-06-23 13:09:38",
				"activities_updated_at": "2020-06-24 05:33:48"
			}		   
Add

Add note to contacts or sales opportunity profile.

ARGUMENTS

action

Required - String

owner_company

Required - String

owner

Required - String

note

Required - Text

idCompany

Required - Integer

id of contact company or 0

idPerson

Required - Integer

id of contact person or 0

idDeal

Required - Integer

id of sales opportunity or 0

POST /profile

Request Example

$ curl https://apicrm.smartysoftware.net/profile/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "addNote"
			"owner_company": "{owner_company}"
			"owner": "{id_user}"
			"note": "{owner_company}"
			"idCompany": "{id_company}"
			"idPerson": "{id_person}"
			"idDeal": "{id_deal}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
				"status": "success",
				"message": "Note added successfully.",
				"id": 610
			}		
 				   
Edit

Edit note of contacts or sales opportunity profile.

ARGUMENTS

action

Required - String

id

Required - Integer

owner_company

Required - String

owner

Required - String

note

Required - Text

idCompany

Required - Integer

id of contact company or 0

idPerson

Required - Integer

id of contact person or 0

idDeal

Required - Integer

id of sales opportunity or 0

POST /note

Request Example

$ curl https://apicrm.smartysoftware.net/note/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "edit"
			"id": "{id_note}"
			"owner_company": "{owner_company}"
			"owner": "{id_user}"
			"note": "{owner_company}"
			"idCompany": "{id_company}"
			"idPerson": "{id_person}"
			"idDeal": "{id_deal}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
				"status": "success",
				"message": "Note edited successfully."
			}		
 				   
Delete

Delete note of contacts or sales opportunity profile.

ARGUMENTS

action

Required - String

id

Required - Integer

owner_company

Required - String

owner

Required - String

note

Required - Text

idCompany

Required - Integer

id of contact company or 0

idPerson

Required - Integer

id of contact person or 0

idDeal

Required - Integer

id of sales opportunity or 0

POST /note

Request Example

$ curl https://apicrm.smartysoftware.net/note/
-X POST
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"action": "removeNote"
			"id": "{id_note}"
			"owner_company": "{owner_company}"
			"owner": "{id_user}"
			"note": "{owner_company}"
			"idCompany": "{id_company}"
			"idPerson": "{id_person}"
			"idDeal": "{id_deal}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8

{
				"status": "success",
				"message": "Note deleted successfully."
			}		
 				   
Search by email

Get contact info by email.

ARGUMENTS

term

Required - String

Person email, Ex: "bart@fullcontact.com"

mode

Required - String

GET /dna

Request Example

$ curl https://apicrm.smartysoftware.net/dna/search
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"term": "{email}"
			"mode": "person"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"data": {
					"requestId": "ee9349ff-c5de-4ea4-8241-6ab6438279d3",
					"likelihood": 0.95,
					"photos": [
						{
							"type": "pinterest",
							"typeId": "pinterest",
							"typeName": "Pinterest",
							"url": "https://img.fullcontact.com/static/68bccf55b1e31a8ad7e2e7523c07c58f_34a01e452d59dbc0558d4ee9892e75227d67451b31013701ff0ebdbefb5fa0bc",
							"isPrimary": true
						}
					],
					"contactInfo": {
						"chats": [
							{
								"client": "aim",
								"handle": "lorangb@me.com"
							},
							.
							.
							.
						],
						"websites": [
							{
								"url": "https://fullcontact.com/bart"
							},
							.
							.
							.
						],
						"familyName": "Lorang",
						"fullName": "Bart Lorang",
						"givenName": "Bart"
					},
					"organizations": [
						{
							"isPrimary": true,
							"name": "FullContact",
							"startDate": "2010-01",
							"title": "Co-Founder and Chief Executive Officer",
							"current": true
						},
						.
						.
						.
					],
					"demographics": {
						"locationDeduced": {
							"deducedLocation": "Denver, Colorado, United States",
							"city": {
								"deduced": false,
								"name": "Denver"
							},
							"state": {
								"deduced": false,
								"name": "Colorado",
								"code": "CO"
							},
							"country": {
								"deduced": false,
								"name": "United States",
								"code": "US"
							},
							"continent": {
								"deduced": true,
								"name": "North America"
							},
							"county": {
								"deduced": true,
								"name": "Denver"
							},
							"likelihood": 1
						},
						"locationGeneral": "Denver, Colorado, United States",
						"gender": "Male"
					},
					"socialProfiles": [
						{
							"bio": "Co-Founder and CEO of FullContact",
							"type": "aboutme",
							"typeId": "aboutme",
							"typeName": "About.me",
							"url": "https://about.me/lorangb",
							"username": "lorangb"
						},
						{
							"bio": "Entrepeneur, Tech Nerd; CEO and Co-Founder of @fullcontact. Passionate about solving the world's contact information problem and helping entrepreneurs.",
							"followers": 2919,
							"type": "angellist",
							"typeId": "angellist",
							"typeName": "AngelList",
							"url": "https://angel.co/bartlorang",
							"username": "bartlorang",
							"id": "182"
						},
						.
						.
						.
					]
				}
			}		   
Search by company name

Get contact info by company name.

ARGUMENTS

term

Required - String

Ex: Smarty software ltd

mode

Required - String

Company name

GET /dna

Request Example

$ curl https://apicrm.smartysoftware.net/dna/search
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"term": "{company_name}"
			"mode": "company"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"data": [
					{
						"lookupDomain": "smartysoftware.net",
						"orgName": "Smarty Software Ltd.",
						"logo": "https://d2ojpxxtu63wzl.cloudfront.net/v1/thumbnail?size=128&url=https://img.fullcontact.com/static/95cee740ad917ae6b93f2c79036d0bd6_c0e32bbfa01fe3b189994af897a5ad7a51806405de306838d519e79afba91df8",
						"location": {
							"locality": "London",
							"country": {
								"name": "United Kingdom",
								"code": "GB"
							}
						},
						"companyApiLink": "https://api.fullcontact.com/v2/company/lookup?domain=smartysoftware.net"
					},
					{
						"lookupDomain": "smartymarketingcloud.com",
						"orgName": "Smarty Software",
						"logo": "https://d2ojpxxtu63wzl.cloudfront.net/v1/thumbnail?size=128&url=https://img.fullcontact.com/static/1beb72c8acaec2139455946c9a6f5d2f_58080b2f1d6206cfcd931a1edce4f5e9d0c4998a60ab26b98759b90c9568368f",
						"location": {
							"locality": "London",
							"country": {
								"name": "United Kingdom",
								"code": "GB"
							}
						},
						"companyApiLink": "https://api.fullcontact.com/v2/company/lookup?domain=smartymarketingcloud.com"
					},
					{
						"lookupDomain": "smartysoft.in",
						"orgName": "Smarty Software Pvt. Ltd.",
						"logo": "https://d2ojpxxtu63wzl.cloudfront.net/v1/thumbnail?size=128&url=https://d2ojpxxtu63wzl.cloudfront.net/static/bd65e685984d805dd73c04e904b4cc18_7fa4a5acf2939eb08338ba8b552cbece8cf941abaa6d678f5b861d39a987d444",
						"location": {
							"locality": "Mumbai",
							"region": {
								"name": "Maharashtra"
							},
							"country": {
								"name": "India",
								"code": "IN"
							}
						},
						"companyApiLink": "https://api.fullcontact.com/v2/company/lookup?domain=smartysoft.in"
					}
				]
			}		   
Search by company domain

Get company info by domain name.

ARGUMENTS

term

Required - String

Company domain address, Ex: "smartysoftware.net"

GET /dna

Request Example

$ curl https://apicrm.smartysoftware.net/dna/company
-X GET
-H "Authorization: Bearer {access_token}"
-H "Content-Type: application/json"
-F 'JSONString="{
		
			"term": "{company_domain}"
			
}"'

Response Example

HTTP/1.1 200 OK
Content-Type:application/json;charset=UTF-8


			{
				"status": "success",
				"data": {
					"requestId": "bb7be9fe-97a6-444b-a135-04e76b4e7a47",
					"category": [
						{
							"code": "OTHER",
							"name": "Other"
						}
					],
					"logo": "https://img.fullcontact.com/static/95cee740ad917ae6b93f2c79036d0bd6_c0e32bbfa01fe3b189994af897a5ad7a51806405de306838d519e79afba91df8",
					"website": "http://smartysoftware.net",
					"industries": [
						{
							"type": "SIC",
							"name": "Computers, Peripherals, and Software",
							"code": "5045"
						}
					],
					"organization": {
						"name": "Smarty Software Ltd.",
						"approxEmployees": 20,
						"founded": "2013",
						"overview": "SaaS Accounting, CRM, Marketing, Invoicing system for small business owners and entrepreneurs",
						"contactInfo": {
							"phoneNumbers": [
								{
									"number": "+44 20 3637 4716",
									"label": "other"
								}
							],
							"addresses": [
								{
									"addressLine1": "80 Silverthorne Road,",
									"locality": "London",
									"country": {
										"name": "United Kingdom",
										"code": "GB"
									},
									"postalCode": "London",
									"label": "work"
								}
							]
						},
						"images": [
							{
								"url": "https://img.fullcontact.com/static/53624f04c4398a0b23b6e5112497f2b3_9b494e5a6b034a78a8c8d9b54da8b043950db9942d22243b3bf6053db5a846df",
								"label": "twitter"
							},
							.
							.
							.
						]
					},
					"socialProfiles": [
						{
							"bio": "A smart All-in-One business software for #entrepreneurs & #startups to save time & money with payment chasing, marketing, VAT submission Exciting #London tech",
							"followers": 4125,
							"following": 2023,
							"typeId": "twitter",
							"typeName": "Twitter",
							"url": "https://twitter.com/Smarty_Software",
							"username": "Smarty_Software",
							"id": "3065756913"
						},
						{
							"bio": "SaaS Accounting, CRM, Marketing, Invoicing system for small business owners and entrepreneurs",
							"typeId": "crunchbasecompany",
							"typeName": "CrunchBase",
							"url": "http://www.crunchbase.com/organization/smarty-software-ltd",
							"username": "smarty-software-ltd"
						},
						.
						.
						.
					],
					"traffic": {
						"ranking": [
							{
								"rank": 9152885,
								"locale": "global"
							}
						]
					}
				}
			}