Retrieving Actions, Cadences, Steps
Actions are a central concept in Salesloft. An Action denotes a scheduled event between a Salesloft user and one of their people. An Action has a type (i.e. email, call, or "other") and may have other details needed to properly execute it.
Actions allow filtering by due_on, which answers the question, "which actions should the Salesloft user be doing right now?" To get the actions that are currently due, use the filter due_on[lte]=iso8601_timestamp
, with the current time in is8601 format. This will return actions which are due now or overdue. In order to get actions that are overdue, by a certain amount of time, use the filter due_on[lte]=iso8601_time_stamp_from_overdue_time.
Step and cadence resources are used to schedule actions. The API exposes both cadence and step.
By default the step endpoint will return all steps. To search only steps that have currently due actions use the filter has_due_actions=true
in your query. Based on the results of the due steps, cadences can be fetched by id from the associated steps.
Individual users can have thousands of actions due at a time. Best practice is to not to query actions directly, rather go through a cadence/step into the actions for that step, by attaching the step_id
filter to the actions query. In addition to being less resource intensive for both parties, this allows a user to to understand the context about actions they are seeing.
Currently, the Salesloft API supports action / step details for phone type actions / steps only. This will be expanded on in the future; please reach out if you have a pressing use case.