Login

Obtain the auth token of the user

Request

Field Type Description
method string "Login"
parameters object[] An object with data for the method
email string User email
password string User password

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
token string Authorization token
user object[] Logged user basic information
error string Error message

Response success example

{


}

Response error example

{



}

GetProfiles

Gets a list of profiles for the logged user

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetProfiles"

Request example

{

}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
profiles object[] List of profile objects
error string Error message

Response success example

{


}

Response error example

{



}

GetStages

Gets a list of stages of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetStages"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
stages object[] List of stage objects
error string Error message

Response success example

{


}

Response error example

{



}

GetCountries

Gets a list of valid countries

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetCountries"

Request example

{

}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
countries object[] List of countries
error string Error message

Response success example

{


}

Response error example

{



}

GetStates

Gets a list of states of selected country

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetStates"
parameters object[] An object with data for the method
country string The code of the country

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
country MX Code of country
states object[] List of states
error string Error message

Response success example

{


}

Response error example

{



}

GetUsers

Gets a list of users

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetUsers"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
users object[] List of user objects
error string Error message

Response success example

{


}

Response error example

{



}

GetCompanies

Gets a list of companies for selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetCompanies"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
companies object[] List of company objects
error string Error message

Response success example

{


}

Response error example

{



}

GetTypes

Gets a list of company types of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetTypes"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
types object[] List of type objects
error string Error message

Response success example

{


}

Response error example

{



}

GetIndustries

Gets a list of industries of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetIndustries"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
industries object[] List of industry objects
error string Error message

Response success example

{


}

Response error example

{



}

CreateCompany

Creates a Company

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "CreateCompany"
parameters object[] An object with data for the method
profile_id integer The id of the profile
name string The name of the Company
type_id integer The id of the company type
industry_id integer The id of the company industry
website string The website of the company
phone string The phone of the company
billing_name string The billing name of the company
rfc string The rfc of the company
shipping_address object[] An object containing the shipping address of the company
country string The country code. Obtained from the Profiles.GetCountries method
state string The state code. Obtained from the Profiles.GetStates method
street string The street address
number string The number of the house
interior_number string The interior number if any
zip string The zip code
suburb string The suburb if any
city string The city
latitude string The latitude coordinate
longitude string The longitude coordinate
billing_address object[] An object containing the billing address of the company
country string The country code. Obtained from the Profiles.GetCountries method
state string The state code. Obtained from the Profiles.GetStates method
street string The street address
number string The number of the house
interior_number string The interior number if any
zip string The zip code
suburb string The suburb if any
city string The city
latitude string The latitude coordinate
longitude string The longitude coordinate

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
company object[] An object containing the company data
error string Error message

Response success example

{


}

Response error example

{



}

GetContacts

Gets a list of contacts for selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetContacts"
parameters object[] An object with data for the method
profile_id integer The id of the profile
company_id integer The id of the company

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
contacts object[] List of contact objects
error string Error message

Response success example

{


}

Response error example

{



}

GetOrigins

Gets a list of contact origins of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetOrigins"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
origins object[] List of origin objects
error string Error message

Response success example

{


}

Response error example

{



}

GetDepartments

Gets a list of departments of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetDepartments"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
departments object[] List of department objects
error string Error message

Response success example

{


}

Response error example

{



}

GetPositions

Gets a list of positions of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetPositions"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
positions object[] List of position objects
error string Error message

Response success example

{


}

Response error example

{



}

GetTitles

Gets a list of titles of selected profile

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetTitles"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
titles object[] List of title objects
error string Error message

Response success example

{


}

Response error example

{



}

CreateContact

Creates a Contact

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "CreateContact"
parameters object[] An object with data for the method
profile_id integer The id of the profile
company_id integer The id of the company this contact belongs to
name string The name of the Contact
surname string The surname of the Contact
mother_surname string The mother surname of the Contact
title_id integer The id of the contact title
origin_id integer The id of the contact origin
position_id integer The id of the contact position
department_id integer The id of the contact department
phone_office string The phone of the contact's office
phone_office_extension string The phone extension of the contact's office
phone_mobile string The mobile phone of the contact
phone_other string Another phone of the contact
email string The email of the contact
skype string The skype of the contact
linkedin string The linkedin of the contact
twitter string The twitter of the contact
shipping_address object[] An object containing the shipping address of the contact
country string The country code. Obtained from the Profiles.GetCountries method
state string The state code. Obtained from the Profiles.GetStates method
street string The street address
number string The number of the house
interior_number string The interior number if any
zip string The zip code
suburb string The suburb if any
city string The city
latitude string The latitude coordinate
longitude string The longitude coordinate
billing_address object[] An object containing the billing address of the contact
country string The country code. Obtained from the Profiles.GetCountries method
state string The state code. Obtained from the Profiles.GetStates method
street string The street address
number string The number of the house
interior_number string The interior number if any
zip string The zip code
suburb string The suburb if any
city string The city
latitude string The latitude coordinate
longitude string The longitude coordinate
assistant object[] An object containing the contact's assistant information
name string The assistant's name
surname string The assistant's surname
mother_surname string The assistant's mother surname
phone_office string The office phone number
phone_office_extension string The office phone number extension if any
email string The email
skype string The skype account
linkedin string The linkedin account

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
contact object[] An object containing the contact data
error string Error message

Response success example

{


}

Response error example

{



}

GetProducts

Gets a list of products

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "GetProducts"
parameters object[] An object with data for the method
profile_id integer The id of the profile

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
products object[] List of product objects
error string Error message

Response success example

{


}

Response error example

{



}

CreateOpportunity

Creates an Opportunity

Header

Field Type Description
Authorization string "Bearer " + Authentication token which was received as the result of Auth.Login method.

Request

Field Type Description
method string "CreateOpportunity"
parameters object[] An object with data for the method
profile_id integer The id of the profile
user_id integer The id of the user that will own the opportunity
title string The title of the opportunity
value float The value of the opportunity
estimated_end_at string The estimated end date of the opportunity. Use format DD/MM/YY
prospect_type string The prospect type of the opportunity. Supported options: 'new' or 'existing'
operation_type string The operation type of the opportunity. Supported options: 'new' or 'renew'
stage_id integer The id of the stage the opportunity will be created at
company_id integer The id of the company the opportunity will be created for
contact_id integer The id of the contact the opportunity will be created for. The contact must belong to the company selected
want_products boolean Indicates if the opportunity has products or not
want_tax boolean Indicates if the opportunity products will have tax or not
products object[] An object containing the information of the products
product_id integer The id of the product
amount integer The amount of products that the opportunity contains
price float The price for each unit of the product
discount float The discount applied for each product
tax float Amount or percentage of the tax applied to the product. from 0.00 to 1.00
total float The total amount for this product
notify boolean Indicates if we want a notification to be sent to the user
comment string The comment that will be sent on the notification

Request example

{


}

Response

Field Type Description
success boolean Indicates if successfull
response object[] An object containing the response data
opportunity object[] An object containing the opportunity data
error string Error message

Response success example

{


}

Response error example

{



}