Retrieves a specified workflow.

GET

https://api.awork.com/api/v1/workflows/:workflowId

Any authenticated user.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

AuthorizationBearer

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

workflowIdstringRequiredformat: "uuid"

idstringOptionalformat: "uuid"

The id of the entity.

createdOnstringOptionalformat: "date-time"

The date this entity was created.

createdBystringOptionalformat: "uuid"

The id of the user who created this entity.

updatedOnstringOptionalformat: "date-time"

The date this entity was last modified.

updatedBystringOptionalformat: "uuid"

The id of the user who last modified this entity.

namestring or nullOptional

The name of the entity.

iconstring or nullOptional

The icon associated with this workflow.

isArchivedbooleanOptional

Whether the workflow has been archived.

isExternalbooleanOptional

True if the workflow is coming from an external workspace (awork Connect). False otherwise.

404

Not Found Error

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"createdOn": "2022-03-11T15:33:47.100Z",
4	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
5	"updatedOn": "2022-03-11T21:15:00.100Z",
6	"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
7	"name": "Website Design and Implementation",
8	"icon": "workflow",
9	"isArchived": true,
10	"isExternal": true
11	}