Skip to main content
GET
List scheduled actions

Authorizations

api_access_token
string
header
required

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
per_page
integer
default:20

Items per page

Required range: 1 <= x <= 100
status
enum<string>

Filter by status

Available options:
scheduled,
executing,
completed,
failed,
cancelled
action_type
enum<string>

Filter by action type

Available options:
send_message,
send_email,
execute_webhook,
trigger_journey,
create_task,
update_deal_stage,
add_deal_note,
send_whatsapp,
send_sms
deal_id
integer

Filter by deal ID

contact_id
string<uuid>

Filter by contact ID

conversation_id
string<uuid>

Filter by conversation ID

scheduled_from
string<date-time>

Start date of scheduling (ISO 8601)

scheduled_to
string<date-time>

End date of scheduling (ISO 8601)

sort
enum<string>
default:scheduled_time

Sorting (recent = most recent, default = by scheduled time)

Available options:
recent,
scheduled_time

Response

List of scheduled actions returned successfully

success
boolean
required
Example:

true

data
object[]
required
meta
object
required
message
string
required
Example:

"Scheduled actions retrieved successfully"