List the workflows of a project (tenant:forge:read)
GET /api/forge/v1/projects/{key}/workflows
Module: Forge · operationId: listForgeWorkflows · Tag: Configuration · Auth: access token (Authorization: Bearer <accessToken>)
Requires tenant:forge:read and a project the caller sees.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
key |
path | string | yes | Project key (e.g. APP) |
Responses
- 200 The workflows (
application/json) - 404 Error (
application/json)
Fields of the 200 answer:
items(array of Workflow, required)id(string (uuid), required): Workflow idkey(string, required): Workflow key; never changesname(string, required): Display nameposition(integer, required): Order in the configurationstatusIds(array of string (uuid), required): Statuses of the workflowtransitions(array of Transition, required): Empty = free movement among the statusesfromStatusId(string (uuid), required): Status the move starts fromtoStatusId(string (uuid), required): Status the move leads to
version(integer, required): Optimistic-locking version; send it with PATCH
Example 200 answer:
{
"items": [
{
"id": "6e2f3a4b-5c6d-4e7f-9a8b-2c3d4e5f6a01",
"key": "standard",
"name": "Standard",
"position": 0,
"statusIds": [
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f01",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f02",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f03",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f04",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f05",
"5d1e2f3a-4b5c-4d6e-8f7a-1b2c3d4e5f06"
],
"transitions": [],
"version": 1
}
]
}
Example request
curl -X GET 'https://api.mbcom.cloud/api/forge/v1/projects/string/workflows' \
-H "Authorization: Bearer $ACCESS_TOKEN"