SupportAPI SpecsAPI Docs
LogoDeveloper Portal

Get started

OverviewGetting StartedNotifications

Development

Development EnvironmentDevelopment Guidelines

Using the API

API ScopesAPI CredentialsAPI LimitsAuthentication and AuthorizationAPI RequestsAPI ResponsesCustom Data FieldsUploading and Downloading DocumentsAPI EndpointsReporting Endpoints

Demonstration App

OverviewMattersData Collections and FieldsDocumentsFile NotesREST Hooks

Errors and Testing

Error HandlingError CodesTesting and Debugging

REST Hooks

REST Hooks and Event Notifications

Tutorials

Working with Custom Data FieldsWorking with Step Data FieldsManaging document tagsDeep Links

Resources

Review ProcessVersioningFAQsGlossaryChange LogTerms and ConditionsCore Resources

Zapier

Actions and TriggersCustom Data Fields for Matters

Getting Started

What do I need to do to get started with using the Actionstep API? 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. There is a $500 set up fee that will be invoiced upon receiving your request for API Credentials.

  3. Please read and understand our Terms and Conditions.

  4. Please read our Development Guidelines.

  5. Familiarise 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.

  6. 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.

  7. 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.