Retrieves automations of the specified workflow. | awork API

1 curl https://api.awork.com/api/v1/workflows/workflowId/automations \ 2 -H "Authorization: Bearer <token>"

1 [ 2 { 3 "id": "123e4567-e89b-12d3-a456-426614174000", 4 "createdBy": "123e4567-e89b-12d3-a456-426614174000", 5 "createdOn": "2024-01-15T09:30:00Z", 6 "updatedBy": "123e4567-e89b-12d3-a456-426614174000", 7 "updatedOn": "2024-01-15T09:30:00Z", 8 "triggerId": "123e4567-e89b-12d3-a456-426614174000", 9 "trigger": { 10 "updatedOn": "2024-01-15T09:30:00Z", 11 "type": "task-created", 12 "values": [ 13 { 14 "name": "name", 15 "value": "Design" 16 } 17 ] 18 }, 19 "enabled": true, 20 "state": "string", 21 "createdByProjectTemplate": false, 22 "projectId": "123e4567-e89b-12d3-a456-426614174000", 23 "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000", 24 "actions": [ 25 { 26 "id": "123e4567-e89b-12d3-a456-426614174000", 27 "createdBy": "123e4567-e89b-12d3-a456-426614174000", 28 "createdOn": "2024-01-15T09:30:00Z", 29 "updatedBy": "123e4567-e89b-12d3-a456-426614174000", 30 "updatedOn": "2024-01-15T09:30:00Z", 31 "type": "tag-add-task", 32 "order": 2, 33 "values": [ 34 { 35 "name": "tag", 36 "value": "Design" 37 } 38 ] 39 } 40 ], 41 "workflowId": "123e4567-e89b-12d3-a456-426614174000", 42 "createdByAutomationIdFromWorkflow": "123e4567-e89b-12d3-a456-426614174000", 43 "failed": { 44 "code": "not-found", 45 "description": "There is no matching path for this URL.", 46 "link": "https://developers.awork.com", 47 "details": [ 48 "No project with the id '123' exists." 49 ], 50 "validationErrors": [ 51 { 52 "property": "FirstName", 53 "message": "FirstName is required." 54 } 55 ], 56 "traceId": "a65ce5745df02af216715ff06661fb3a" 57 } 58 } 59 ]

Required Permissions

The user must be an admin or have project-manage-config:read permissions.

<Check title="Required Permissions" icon="key">The user must be an admin or have `project-manage-config:read` permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workflowIdstringRequiredformat: "uuid"

Response

idstring or nullformat: "uuid"

The id of the automation.

createdBystring or nullformat: "uuid"

The id of the user who created the automation.

createdOndatetime or null

The date the automation was created.

updatedBystring or nullformat: "uuid"

The id of the user who updated the automation.

updatedOndatetime or null

The date the automation was updated.

triggerIdstring or nullformat: "uuid"

The id of the trigger which is related to the automation.

triggerobject or null

enabledboolean or null

Whether the automation is enabled.

statestring or null

The state of the automation. See AutomationsService.DAL.Models.AutomationState for the possible values.

createdByProjectTemplateboolean or null

Whether the automation was created from an automation template of a project template.

projectIdstring or nullformat: "uuid"

The id of the project which is related to the automation.

projectTemplateIdstring or nullformat: "uuid"

The id of the project template which is related to the automation.

actionslist of objects or null

The actions which is related to the automation.

workflowIdstring or nullformat: "uuid"

The workflow this automation belongs to, if any.

createdByAutomationIdFromWorkflowstring or nullformat: "uuid"

The id of the workflow automation that served as the template for this automation.

failedobject or null

The API error response.