API v1 ReferenceWorkflows

Retrieves a specified workflow.

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

Authentication

AuthorizationBearer

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

Path parameters

workflowIdstringRequiredformat: "uuid"

Response

OK
idstringformat: "uuid"
The id of the entity.
createdOndatetime
The date this entity was created.
createdBystringformat: "uuid"
The id of the user who created this entity.
updatedOndatetime
The date this entity was last modified.
updatedBystringformat: "uuid"
The id of the user who last modified this entity.
namestring or null
The name of the entity.
iconstring or null
The icon associated with this workflow.
isArchivedboolean
Whether the workflow has been archived.
isExternalboolean

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

Errors

404
Not Found Error