workflows

Returns workflows.

Changed on

Returns workflows. Each workflow includes its linked statuses and custom fields. <Check title="Required Permissions" icon="key">The user must have permission to access the requested resource.</Check>

get/workflows

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/workflows
  • Auth: HTTP bearer

Query parameters

showArchivedboolean
pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

namestring nullable

The name of the entity.

iconstring nullable

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.

Changes