Every project environment comes with a single workflow marked as Default. In subscriptions with multiple workflows, your environments might contain several workflows with different workflow steps.The workflows themselves consist of a number of steps, with two predefined steps, Published and Archived. Workflow steps indicate a specific stage in the content production process. For example, Draft -> Review -> Legal approval -> Published. Every variant of a content item (such as English, Spanish, French) can be moved to a specific workflow step.The combination of workflow and its workflow step might affect who can edit the variant and who can move the variant to another workflow step. Check how to set up a workflow for your content.
Retrieve a list of workflows with information about the workflow steps they define.
Workflows in the specified environment.
Get the workflow steps from the default workflow in your environment.
A list of workflow steps in the specified environment.
Update an existing workflow, manage its scope, workflow steps and their transitions, and role permissions. Always make sure that all steps eventually transition to the Published step.When removing a workflow step, make sure the step is not in use. You can't remove a used workflow step.
Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
The workflow's internal ID. The ID of the default workflow is always 00000000-0000-0000-0000-000000000000.
Identifies the workflow by its internal ID (e.g., 8bfdb62d-7aa1-473b-9d80-311ef93db108) or codename (e.g., codename/my-workflow).
The workflow's display name.
The workflow's codename.
Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
The workflow's internal ID. The ID of the default workflow is always 00000000-0000-0000-0000-000000000000.
Identifies the workflow by its internal ID (e.g., 8bfdb62d-7aa1-473b-9d80-311ef93db108) or codename (e.g., codename/my-workflow).
The workflow steps in this workflow.
The workflow's predefined Published workflow step.
The workflow's predefined Archived workflow step.
Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
The workflow steps in this workflow.
The workflow's predefined Published workflow step.
The workflow's predefined Scheduled workflow step.
The workflow's predefined Archived workflow step.
The workflow's codename.
Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
References to the content types limited to this workflow.
The referenced object's internal ID.
The workflow steps in this workflow.
The workflow step's internal ID.
The workflow step's display name.
The workflow's predefined Published workflow step.
The Published workflow step's internal ID.
The Published workflow step's display name.
The workflow's predefined Scheduled workflow step.
The Scheduled workflow step's internal ID.
The Scheduled workflow step's display name.
The workflow's predefined Archived workflow step.
The Archived workflow step's internal ID.
The Archived workflow step's display name.
The workflow step's codename.
The workflow steps that this step can transition to, represented by their internal IDs.
The workflow steps in this workflow.
The workflow's predefined Published workflow step.
The workflow's predefined Archived workflow step.
Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
The workflow steps in this workflow.
The workflow's predefined Published workflow step.
The workflow's predefined Scheduled workflow step.
The workflow's predefined Archived workflow step.
Workflows | Kontent.ai Learn
References to the content types limited to this workflow.
The referenced object's internal ID.
The workflow step's codename.
The workflow step's color in a human-readable format.
References to the workflow steps that this step can transition to. Workflow steps can be referenced either by their codename or internal ID.
Reference to a specific object in the environment.
The roles that can work with this step, represented by their internal IDs. If empty, all roles can work with this step.
The Published workflow step's codename.
The internal IDs of the roles that can unpublish and archive content items using this workflow. If empty, all roles can unpublish and archive content items.
The internal IDs of the roles that can create new versions of content items using this workflow. If empty, all roles can create new versions.
The Scheduled workflow step's codename.
The Archived workflow step's codename.
The internal IDs of the roles that can restore archived content items using this workflow. If empty, all roles can restore archived content items.
The workflow's internal ID. The ID of the default workflow is always 00000000-0000-0000-0000-000000000000.
The workflow's display name.
The workflow's codename.
Specifies the content types and collections that this workflow is limited to. If both content types and collections are empty, the workflow can be used for any type of content in collection that isn't limited to any other workflow.Changing the workflow's scope doesn't affect existing content items unless you change their workflow manually.
The workflow steps in this workflow.
The workflow's predefined Published workflow step.
The workflow's predefined Scheduled workflow step.
Deprecation noticeIn April 2022, this endpoint was deprecated in favor of the Retrieve workflows endpoint, which supports multiple workflows.
Prefer codenames over IDs when referring to workflow stepsYou can reference existing workflow steps by their codename or ID. We recommend using codenames because it makes your code cleaner and easier to manage. Use ID only when you need to change the codename of a workflow step.If you want to reuse codenames of existing workflow steps in new workflow steps, you need to make two requests. First remove the workflow step with the desired codename. This make the codename available. Then add a new workflow step.
, your environments might contain several workflows with different workflow steps.The workflows themselves consist of a number of steps, with two predefined steps, Published and Archived. Workflow steps indicate a specific stage in the content production process. For example, Draft -> Review -> Legal approval -> Published. Every variant of a content item (such as English, Spanish, French) can be moved to a specific workflow step.
The combination of workflow and its workflow step might affect who can edit the variant and who can move the variant to another workflow step. Check how to set up a workflow for your content.
