Get Automations

get

https://api.zylo.com/v2/automations

Required Permissions

automations

Rate Limit

basic

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

category_tags

array of strings

Category tags assigned to the automation.

category_tags

created_by

string

The user who created the automation.

string

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Unique identifier for the automation.

last_run_time

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Timestamp of the most recent execution.

last_status

string

enum

The status of the most recent execution (SUCCESS, ERROR, STOPPED, TIMED OUT, IN PROGRESS).

Allowed:

modified_by

string

The user who last modified the automation.

name

string

The name of the automation.

next_execution_time

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

The next scheduled execution time.

run_count

string

^^([0-9]{1,}([.][0-9]{0,})?,(gt|gte),([0-9]{1,}([.][0-9]{0,})?,(lt|lte)))$|^([0-9]{1,}([.][0-9]{0,})?,(lt|gt|gte|lte))$

Total number of times the automation has been executed.

state

string

enum

Whether the automation is ACTIVE or INACTIVE.

Allowed:

zylo_created_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date the automation was created.

zylo_modified_at

string

^^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(gt|gte),[0-9]{4}-[0-9]{2}-[0-9]{2},(lt|lte)))$|^([0-9]{4}-[0-9]{2}-[0-9]{2}(,(lt|gt|gte|lte)))$

Date the automation was last modified.

sort

string

Defaults to +zylo_created_at

Sort by any non-object or array value. Use +/- to indicate direction.

limit

double

≤ 1000

Defaults to 50

Number of results to bring back.

skip

double

Defaults to 0

Offset the results by this number.

cursor

string

id value to use cursor based pagination. Can be used in place of skip.

string

Search the results by this string.

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok