Rest Documentation

All REST requests should be submitted through your company's service URL.

Your company's standard REST URL is as follows: Substitute your company's actual subdomain in the URL.

You will need to use the webservice documentation, which lists all the object types, fields (including custom fields) and methods.

To access this documentation, login to your system, and go to:
Admin Tab >> Manage Web Services >> Web services Documentation

Request/Response Structure

To make a request to the webservice, make a POST request to the REST URL. The format of the body should be JSON in the following structure:

{"operation":"getLeads","parameters":[parameter1, parameter2, etc]}

Substitute 'getLeads' with whatever method you are calling. Note that parameters is an array of parameters. To call a method that only takes a single parameter, you must still put the single parameter in the array. Responses from the webservice will be in JSON, including when errors occur.


Available Methods

The first method you should call is 'login'. Login authenticates your session and sends back a PHPSESSID cookie, which it will expect to be present in all future request for this session. The login method requires three parameters: username, password, security_token.

Each of the primary object types have several common methods, in the form of addLead or updateAccount:

  1. add - Used when you are adding a new object of this type. The first parameter is required, and is an object of that type.
  2. update - For updating objects. The first parameter is an object. It requires a valid object id to be set in the object to find the object to update.
  3. delete - Marks an object as deleted. Pass in the id of the object to delete.
  4. upsert - This is a convenience method that will try to update an object if your first parameter has an ID, otherwise it will add a new object.
  5. get - Allows you to perform searches and get the matching objects. The first parameter is an array of Filters, and the other two control paging


All getObject methods rely on the concept of Filter objects. If you wanted to get a list of deleted leads created on or after July 2nd 2010, you would need to create two filters.

A filter is composed of three parts: field, operator, and values. To build the filter to look for deleted leads, we would do something like this:

deleted_filter = {'field':'deleted', 'operator':'=', 'values':['1']}

Notice that 'values' is an array of strings. Because in this case we are making a filter on a boolean we use the '=' operator and specify a single value of '1', which is how you search for true. Now we need to make another filter to look for leads created on or after today:

today_filter = {'field':'date_created', 'operator':'>', 'values':['2010-07-02 00:00:00']}


Now that we have both filters, we can call the getLeads method in the webservice by passing in an array of those two filters as the first parameter.

Release Notes

Find our most recent release notes.


Our community forum is coming soon.

Advanced Training Guides

Advanced training for the Lead Management Platform.

Have questions?

We're happy to help. An expert is just a phone call away.

(866) 593-2807

Mon-Fri 6-7 MST

Back To Top

© 2004–2014, Inc. all rights reserved. Use of the service and this Web site constitutes acceptance of our Terms of Use and Privacy Policy. technology is protected by the following United States Patents: 8078605, 8325738, 8352389, 8510382, 8566419.