Skip to main content
GET
Read automation

Authorizations

Authorization
string
header
required

Use a valid Bearer token to authenticate.

Query Parameters

page
integer
default:1

The page number of results to retrieve. Example: 2

limit
integer
default:20

Specifies the maximum number of items to retrieve in a single request. Example: 10

Required range: 1 <= x <= 1000
q
string

Query param search. This field will search automation according to similar value of name, automation type or flow Example: Automation Tigaraksa, createTask, Delivery

sortBy
string

sortBy is used to sort the result-set in ascending or descending order according to selected field. The value of this param is one of available fields on automation objects. Example: name, flow, automationType, createdTime, etc. Default: createdTime

sortOrder
string

sortOrder is to decide ascending or descending order Example: asc or desc. Default: desc

fields
string

Fields is for selecting the specific fields that you can choose by multiples to show in the response using a string with a comma delimiter. Example: name,automationType,flow.

event
string

Act as a trigger that start an automation. Example: onTaskCreated

automationType
string

Automation's type. The action of automation. Example: webhook.

dataType
string

Automation's data type. Example: task.

flow
string

FlowName to select specific task for event to happens. Use GET /flows API to get the list of Flow. Example: Pickup

Response

Success

status
boolean

Status of response.

message
string

Message of API response.

data
object

List of object automation.