Overview

The Squish API is located at https://api.squishlist.com. Except where noted, it is expected that you send parameters via the URL query string (i.e. GET). You can view more details about each service and individual methods using the links at the top of this page.

Authentication

Authentication is done by sending the following parameters to the /auth/ endpoint. Parameters may be sent via either GET or POST (POST will ensure parameter values do not show up in logs). The return value will contain a token key that you must use when making further API calls.

• cfg - The short name of the company (i.e. what shows up in the URL for that company)
• user_key - Your private user key (found on your profile page, if you have access to any API keys)
• api_key - A company API key

Method Calls

All other method calls are made by sending the following parameters (plus method-specific parameters) to the /rest/ endpoint.

• cfg - The short name of the company
• token - The authentication token returned from /auth/
• method - The method you wish to call

On each service documentation page, there is a "Try It" button for each method. At the top of the page, you can specify your company (cfg) and API token received from the authentication endpoint described above. The URLs for each method will be updated to reflect those values. Pressing "Try It" will attempt to call the web service and display any results.