v1
latestOpenAPI 3.0.02026-08-04181876.9 KBautomations
List automations
Retrieves a list of the automations that the requesting user has access to.
get/api/v1/automations
Query parameters
cursorstring
Example:eyJpZCI6MjIwMjA5MDgsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0
Pagination cursor returned from a previous request.
filterstring
Example:name eq "My Automation" and runMode eq "scheduled" and ownerId eq "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy"
Allowed filters: name, runMode, lastRunStatus, ownerId, spaceId.
limitinteger
Example:50
The number of automations to retrieve.
listAllboolean
When true, list all automations. Restricted to tenant admins and analytics admins.
sort'id' | 'name' | 'runMode' | 'state' | 'createdAt' | 'updatedAt' | 'lastRunAt' | 'lastRunStatus' | '+id' | '+name' | '+runMode' | '+state' | '+createdAt' | '+updatedAt' | '+lastRunAt' | '+lastRunStatus' | '-id' | '-name' | '-runMode' | '-state' | '-createdAt' | '-updatedAt' | '-lastRunAt' | '-lastRunStatus' | 'maxConcurrentRuns' | '+maxConcurrentRuns' | '-maxConcurrentRuns'
Example:-name
The field to sort by, with +- prefix indicating sort order. (?sort=-name => sort on the name field using descending order).
Response
OK Response
Example response
{
"data": [
{
"id": "e0e720d0-4947-11ec-a1d2-9559fa35801d",
"state": "available",
"lastRun": {
"id": "d452d100-9b0b-11ec-b199-8323e1031c3e",
"metrics": {
"blocks": [
{
"type": "endpointBlock",
"rxBytes": 18329921,
"txBytes": 18329921,
"apiCalls": 40
}
]
},
"stopTime": "2021-12-23T12:28:21.000000Z",
"createdAt": "2021-12-23T12:28:21.000000Z",
"startTime": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"scheduledStartTime": "2021-12-23T12:28:21.000000Z"
},
"ownerId": "sWYAHxZxhtcmBT7Ptc5xJ5I6N7HxwnEy",
"runMode": "triggered",
"spaceId": "5f0f78b239ff4f0001234567",
"createdAt": "2021-12-23T12:28:21.000000Z",
"lastRunAt": "2021-12-23T12:28:21.000000Z",
"updatedAt": "2021-12-23T12:28:21.000000Z",
"workspace": {},
"snippetIds": [
"e0e720d0-4947-11ec-a1d2-9559fa35801d"
],
"endpointIds": [
"9d94bef0-b28c-11eb-8dba-01593c457362",
"53a6fb70-b28f-11eb-b601-b545a40867e0"
],
"connectorIds": [
"0d87808f-27c0-11ea-921c-022e6b5ea1e2",
"0d86ee8a-27c0-11ea-921c-022e6b5ea1e2"
],
"lastRunStatus": "finished",
"executionToken": "aZXuEogT9X3le0k0WXMBnzuYKq4xRlkDnurjs8NVhEAAW1BYx8C1PpIl3ielgRb1",
"maxConcurrentRuns": 10
}
]
}