Actionstep API

Created by Kylie Mitchell, Modified on Tue, 29 Nov 2022 at 06:46 PM by Kylie Mitchell

The Actionstep API allows software developers to create a wide variety of apps (mobile, web, tablet, embedded, desktop) using Actionstep as the backend database.

 Actionstep is a comprehensive business management platform and contains built-in data structures and business models to handle things like workflow, document management, contacts, calendaring, time sheets, billing, trust accounting, and general ledger. This lets you, the software developer, focus on building a stunning front-end application without having to worry about the complexities of the business back-end.

 Another great reason to use Actionstep as your back-end database is that it lets you create custom back-end workflows and custom data structures to support your front-end application. So, for example, if you wanted to create a mobile app for salespeople, you could define a companion sales pipeline workflow on the back-end (initial inquiry > qualified prospect > engaged > contract) with some custom data fields (contract amount, products of interest, etc.) and operate on these fields from your front-end app. You will also have access to all of Actionstep's standard business functions like tasks, steps, CRM, quotes, invoices, etc.

 You communicate with the API using standard HTTP requests and responses (GET, POST, etc.). You can use any programming language on your end (JavaScript, C#, PHP, etc.) and most have built-in libraries for HTTP communication.


Click here for the API technical documentation

NOTE: There is a $500 initial setup charge for access to the API. This includes a "sandbox" database (blank or copied from your current system) to test your integration, and the generation of the API keys you will use for your development.



How To Get Started

Here are the simple steps to get you started:

  1. Make a request to our Global Support Team for access to our API. Please provide a brief description of the project you are undertaking so we can assist you with setting everything up. Our API is broken down into many different scopes and by knowing the type of project you are undertaking means we can ensure you have access to the right scopes. The Global Support Team will place a copy of your live Actionstep system (if applicable) into the sandbox (development and testing) environment, and will create a special Admin login for you to access the system. The Global Support Team will issue you a set of API Credentials to allow you access to your development sandbox system using the API. These take the form of an API Access Key and a Client Secret. You will need both during the authentication process.

  2. Please read and understand our Terms and Conditions.

  3. Please read our Development Guidelines.

  4. Familiarize yourself with the API. The simplest way to do this is to use Postman. We have created a configuration file you can import into Postman that allows you to investigate our API in more detail before you start coding. This fast tracks your understanding of how requests are composed and the corresponding responses. The Global Support Team will supply you with the the required files upon request.

  5. Use the menu links on the left to gain further understanding on how our API works, particularly the authentication process which can be a little tricky if you have not used OAuth before.

  6. Start coding!


Deploying To Production

Once you have completed your project you will need to go through our API Review Process. Once successfully completed we will issue you with a set of production API Credentials allowing your integration project to 'go live' in production. You will need to deploy your application to your own production environment and use the production API Credentials to point to your live Actionstep system.



API Support

Once your API environment has been established all API-related support inquiries should be sent to support@actionstep.com