Skip to main content
GET
List scheduled actions

Autorizações

api_access_token
string
header
obrigatório

Parâmetros de consulta

page
integer
padrão:1

Page number

Intervalo obrigatório: x >= 1
per_page
integer
padrão:20

Items per page

Intervalo obrigatório: 1 <= x <= 100
status
enum<string>

Filter by status

Opções disponíveis:
scheduled,
executing,
completed,
failed,
cancelled
action_type
enum<string>

Filter by action type

Opções disponíveis:
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>
padrão:scheduled_time

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

Opções disponíveis:
recent,
scheduled_time

Resposta

List of scheduled actions returned successfully

success
boolean
obrigatório
Exemplo:

true

data
object[]
obrigatório
meta
object
obrigatório
message
string
obrigatório
Exemplo:

"Scheduled actions retrieved successfully"