> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://contentful.com/developers/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://contentful.com/_mcp/server.

Users can add comments to a workflow. This allows for teams to provide additional context to a certain workflow step change.

#### Availability

Workflow comments are globally available for all customers.

### Workflow comment schema

A workflow comment has two top-level properties: `body` and `sys`.
These are described in detail below.

| Field  | Type   | Required | Description                                                                              |
| ------ | ------ | -------- | ---------------------------------------------------------------------------------------- |
| body   | String | true     | The body of the comment. It has a maximum size of 512 bytes                              |
| status | String | false    | The status of the comment, it can be either `active` or `resolved`. `active` by default. |
| sys    | Object | true     | System resource properties                                                               |

In addition to the [common sys properties](#/introduction/common-resource-attributes) comments have the following extra `sys`
properties

| Field        | Type          | Description                                                 |
| ------------ | ------------- | ----------------------------------------------------------- |
| parentEntity | VersionedLink | A reference to the workflow within which the comment exists |
| parent       | Link          | A reference to the replied comment (optional)               |
| resolvedBy   | Link          | A reference to the user who resolved the comment (optional) |

The property `resolvedBy` is only defined if the comment is resolved. Reopening a comment will remove the field from the sys section.

## Workflow comments collection

[Get all comments of a workflow](/references/content-management-api/workflow-comments/get-all-comments-of-a-workflow)

Use this endpoint to get all the comments of a workflow.

It is possible to filter comments by optionally providing the `status` query parameter, if no value is provided comments with any status will be returned.

#### Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

## Workflow versioned comments collection

[Get all comments of a specific workflow version](/references/content-management-api/workflow-comments/get-all-comments-of-a-specific-workflow-version)

Use this endpoint to get all the comments of a workflow with a specific version.

#### Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

## Workflow comment

[Create a workflow comment](/references/content-management-api/workflow-comments/create-a-workflow-comment)

Use this endpoint to create a workflow comment for a specific workflow version. Currently we only support one workflow comment per workflow version.

#### Permissions

Any user with read access to workflows in the given space-environment can call this endpoint.

#### Errors

* A `400 - BadRequest` error is returned if there's an attempt to create more than one
  workflow comment for a given workflow version.
* A `422 - ValidationFailed` error is returned if:
  * The `body` field has a value bigger than 512 bytes


## API Docs

- Workflow Comments [Get all comments of a workflow](https://contentful.com/developers/docs/references/content-management-api/workflow-comments/get-all-comments-of-a-workflow.md)
- Workflow Comments [Get all comments of a specific workflow version](https://contentful.com/developers/docs/references/content-management-api/workflow-comments/get-all-comments-of-a-specific-workflow-version.md)
- Workflow Comments [Create a workflow comment](https://contentful.com/developers/docs/references/content-management-api/workflow-comments/create-a-workflow-comment.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://contentful.com/developers/docs/openapi.json)
- [OpenAPI YAML](https://contentful.com/developers/docs/openapi.yaml)