SupportAPI SpecsAPI Docs
LogoDeveloper Portal

Get started

OverviewGetting StartedNotifications

API Endpoints

Introduction

The Actionstep API consists of a large number of individual endpoints for GET, POST, PUT and DELETE requests. You can find our current endpoint documentation here.

Please Note: We are in the process of migrating all our API documentation over from Atlassian to this site. Please check back periodically for latest updates.

OpenAPI Endpoint Specifications

These endpoint specification files are in OpenAPI 3.0.3 format and can be viewed using https://editor.swagger.io/

EndpointDownload Link
actionsactions.yaml
actionbillsettingsactionbillsettings.yaml
actionfoldersactionfolders.yaml
actionnetdocssettingsactionnetdocssettings.yaml
actionparticipantsactionparticipants.yaml
actiontypesactiontypes.yaml
actiontypeparticipanttypesactiontypeparticipanttypes.yaml
billsbills.yaml
contactdocumentscontactdocuments.yaml
contactfolderscontactfolders.yaml
contactnotescontactnotes.yaml
contactrelationshipscontactrelationships.yaml
datacollectionsdatacollections.yaml
datacollectionfieldsdatacollectionfields.yaml
datacollectionfielddropdownchoicesdatacollectionfielddropdownchoices.yaml
datacollectionrecordsdatacollectionrecords.yaml
datacollectionrecordvaluesdatacollectionrecordvalues.yaml
disbursementsdisbursements.yaml
filenotesfilenotes.yaml
participantsparticipants.yaml
participantdefaulttypesparticipantdefaulttypes.yaml
phonerecordsphonerecords.yaml
resthooksresthooks.yaml
timeentriestimeentries.yaml
taskstasks.yaml

Using Postman

Using Postman is a great way to experiment and become familiar with the Actionstep API. Actionstep has created a configuration file with all endpoints pre-configured to fast-track your learning. Download Postman Configuration File

For more information on using Postman see our Quick Start Guide to using Postman.